appflow live-update upload-artifact

info

This feature is only available to Enterprise customers with access to Self-hosted Live Updates.

[appflow, live-update, upload-artifact]

Bundle and upload a Live Update artifact in Appflow

appflow live-update upload-artifact [flags]

Examples

appflow live-update upload-artifact --app-id=12345 --build-dir=www --commit-sha=95f66b50279d54b1f0733e9188fd454768f3fd96 --signing-key=$IONIC_SIGNING_KEY --commit-ref=main [--commit-message=initial]

Aliases

• "upload"

Flags

Name	Type	Default	Description
--app-id [required]	string		Appflow app id
--build-dir [required]	string		Web asset path (e.g. 'www')
--commit-ref [required]	string		Git commit ref such as a branch or a tag
--commit-sha [required]	string		Git commit SHA
--signing-key [required]	string		Private signing key as a string or the path to a file containing the private signing key
--artifact-type	string		The type of the Live Update Artifact being uploaded ("zip" / "manifest"), defaults to "zip"
--commit-message	string		Commit message to be displayed in Appflow

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.
buildId (optional)	number	A unique identifier for a build done in Appflow.
buildNumber (optional)	number	An app-specific build number for builds done in Appflow.
buildStatus	"CREATED" | "PENDING" | "RUNNING" | "BUILDING" | "FAILED" | "SUCCESS" | "CANCELED"	The current state of your build in Appflow.
platform	"ANDROID" | "IOS" | "WEB"	The ecosystem you are building for.
buildDir	string	The directory that contains the files from a completed build, for bundling.
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",
  "buildId": 6010455,
  "buildNumber": 25,
  "buildStatus": "SUCCESS",
  "platform": "WEB",
  "buildDir": "./www/",
  "commitSha": "cef1sdca",
  "commitRef": "main",
  "commitMessage": "feat: enable customer delight"
}

JSONText

Failed Output

{
  "appId": "052b32ac",
  "buildId": null,
  "buildStatus": "FAILED",
  "platform": "WEB",
  "buildDir": "./www/",
  "commitSha": "cef1sdca",
  "commitRef": "main",
  "commitMessage": "feat: enable customer delight"
}

JSONText