Add commands for exporting and importing app/fleet releases.

Change-type: minor Signed-off-by: Carlo Miguel F. Cruz <[email protected]>
balena-io · Aug 29, 2024 · 3525278 · 3525278
1 parent a9a2022
commit 3525278
Show file tree

Hide file tree

Showing 7 changed files with 622 additions and 319 deletions.
diff --git a/completion/_balena b/completion/_balena
@@ -22,7 +22,7 @@ _balena() {
   key_cmds=( add rm )
   local_cmds=( configure flash )
   os_cmds=( build-config configure download initialize versions )
-  release_cmds=( finalize invalidate validate )
+  release_cmds=( export finalize import invalidate validate )
   tag_cmds=( rm set )
 
 

diff --git a/completion/balena-completion.bash b/completion/balena-completion.bash
@@ -21,7 +21,7 @@ _balena_complete()
   key_cmds="add rm"
   local_cmds="configure flash"
   os_cmds="build-config configure download initialize versions"
-  release_cmds="finalize invalidate validate"
+  release_cmds="export finalize import invalidate validate"
   tag_cmds="rm set"
 
 

diff --git a/docs/balena-cli.md b/docs/balena-cli.md
@@ -282,7 +282,9 @@ are encouraged to regularly update the balena CLI to the latest version.
 
 - Releases
 
+	- [release export &#60;commitorid&#62;](#release-export-commitorid)
 	- [release finalize &#60;commitorid&#62;](#release-finalize-commitorid)
+	- [release import &#60;file&#62;](#release-import-file)
 	- [release &#60;commitorid&#62;](#release-commitorid)
 	- [release invalidate &#60;commitorid&#62;](#release-invalidate-commitorid)
 	- [release validate &#60;commitorid&#62;](#release-validate-commitorid)
@@ -3345,6 +3347,31 @@ The notes for this release
 
 # Releases
 
+## release export &#60;commitOrId&#62;
+
+Saving a release to a file allows you to import an exact 
+copy of the original release into another application.
+
+Only successful releases can be saved into a file.
+
+Examples:
+
+	$ balena release export a777f7345fe3d655c1c981aa642e5555 -o ../path/to/release.tar
+	$ balena release export 1234567 -o ../path/to/release.tar
+	$ balena release export myOrg/myFleet:1.2.3 -o ../path/to/release.tar
+
+### Arguments
+
+#### COMMITORID
+
+commit, ID, or version of the release to export
+
+### Options
+
+#### -o, --output OUTPUT
+
+output path
+
 ## release finalize &#60;commitOrId&#62;
 
 Finalize a release. Releases can be "draft" or "final", and this command
@@ -3371,6 +3398,36 @@ the commit or ID of the release to finalize
 
 ### Options
 
+## release import &#60;file&#62;
+
+To save a release into a file, use 'balena release export'.
+
+Use the --override-version option to specify the version 
+of the imported release, overriding the one saved in the file.
+
+Examples:
+
+	$ balena release import ../path/to/release.tar -f 1234567
+	$ balena release import ../path/to/release.tar -f myFleet
+	$ balena release import ../path/to/release.tar -f myOrg/myFleet
+	$ balena release import ../path/to/release.tar -f myOrg/myFleet -V 1.2.3
+
+### Arguments
+
+#### BUNDLE
+
+path to a file, e.g. "release.tar"
+
+### Options
+
+#### -f, --fleet FLEET
+
+fleet name or slug (preferred)
+
+#### -V, --override-version OVERRIDE-VERSION
+
+Imports this release with the specified version overriding the version in the file.
+
 ## release &#60;commitOrId&#62;
 
 The --json option is recommended when scripting the output of this command,