appflow live-update register-artifact
info
This feature is only available to Enterprise customers with access to Self-hosted Live Updates.
[appflow, live-update, register-artifact]
This command registers a pre-bundled Live Update artifact with Appflow, including necessary details about the update's location and metadata. Registration enables Appflow to make the update available for deployment to your app users through a Live Update channel. Note that the update must be uploaded to a hosting provider before running this command.
appflow live-update register-artifact [flags]
Examples
appflow live-update register-artifact --app-id=12345 --artifact-url=https://example.com/builds/95f66b50.zip --commit-sha=95f66b50279d54b1f0733e9188fd454768f3fd96 --commit-ref=main [--commit-message=initial]
Aliases
- "register"
Flags
| Name | Type | Default | Description |
|---|---|---|---|
--app-id [required] | string | Appflow app id | |
--artifact-url [required] | string | The URL to the Self-hosted Live Update Artifact (e.g. 'https://example.com/builds/95f66b50.zip') | |
--commit-ref [required] | string | Git commit ref such as a branch or a tag | |
--commit-sha [required] | string | Git commit SHA | |
--artifact-type | string | The type of the Live Update Artifact being registered ("zip" / "manifest"), defaults to "zip" | |
--commit-message | string | Commit message to be displayed in Appflow | |
--signed | boolean | false | Whether the artifact is signed or not |
Global Flags
| Name | Type | Default | Description |
|---|---|---|---|
-h, --help | boolean | false | Print help information for command |
--config | string | Appflow config file (.appflow.yaml by default) | |
--json | boolean | false | For commands with output, shortcut to print as JSON |
--output | string | "text" | For commands with output, print as [json] or human readable [text] |
--token | string | Ionic authorization token |
Outputs
| Name | Type | Description |
|---|---|---|
appId | string | Your app's unique identifier in Appflow. |
artifactURL | string | The self-hosted URL to be used to retrieve a Live Update. |
buildId | number | A unique identifier for a build done in Appflow. |
buildNumber | number | An app-specific build number for builds done in Appflow. |
commitSha | string | The commit hash. |
commitRef | string | The branch a commit was made on. |
commitMessage (optional) | string | The message that was provided when a commit was made. |
Successful Output
{
"appId": "052b32ac",
"artifactURL": "https://example.com/builds/95f66b50.zip",
"buildId": 6010455,
"buildNumber": 25,
"commitSha": "cef1sdca",
"commitRef": "main",
"commitMessage": "feat: enable customer delight"
}