You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This tool allows for command-line interactions with [ReARM at relizahub.com](https://relizahub.com) (currently in public preview mode). Particularly, Rearm CLI can stream metadata about instances, releases, artifacts, resolve bundles based on ReARM data. Available as either a Docker image or binary.
5
+
This tool allows for command-line interactions with [ReARM at relizahub.com](https://relizahub.com) (currently in public preview mode). Particularly, Rearm CLI can stream metadata about instances, releases, artifacts, resolve products based on ReARM data. Available as either a Docker image or binary.
6
6
7
7
Video tutorial about key functionality of ReARM is available on [YouTube](https://www.youtube.com/watch?v=yDlf5fMBGuI).
8
8
@@ -42,7 +42,7 @@ It is possible to set authentication data via explicit flags, login command (see
42
42
1.[Get Version Assignment From ReARM](#1-use-case-get-version-assignment-from-rearm-hub)
43
43
2.[Send Release Metadata to ReARM](#2-use-case-send-release-metadata-to-rearm-hub)
44
44
3.[Check If Artifact Hash Already Present In Some Release](#3-use-case-check-if-artifact-hash-already-present-in-some-release)
45
-
4.[Request Latest Release Per Component Or Bundle](#6-use-case-request-latest-release-per-component-or-bundle)
45
+
4. Request Latest Release Per Component Or Product
46
46
6.[Persist ReARM Credentials in a Config File](#10-use-case-persist-rearm-hub-credentials-in-a-config-file)
47
47
8.[Create New Component in ReARM](#12-use-case-create-new-component-in-rearm-hub)
48
48
9.[Add new artifacts to release in ReARM](#14-use-case-add-new-artifacts-to-release-in-rearm-hub)
@@ -207,9 +207,9 @@ Flags stand for:
207
207
-**--hash** - flag to denote actual hash (required). By convention, hash must include hashing algorithm as its first part, i.e. sha256: or sha512:
208
208
-**--component** - flag to denote UUID of specific Component, UUID must be obtained from ReARM (optional, required if org-wide or user api key is used).
209
209
210
-
## 6. Use Case: Request Latest Release Per Component Or Bundle
210
+
## 6. Use Case: Request Latest Release Per Component Or Product
211
211
212
-
This use case is when ReARM is queried either by CI or CD environment or by integration instance to check latest release version available per specific Component or Bundle.
212
+
This use case is when ReARM is queried either by CI or CD environment or by integration instance to check latest release version available per specific Component or Product.
213
213
214
214
Sample command:
215
215
@@ -225,12 +225,12 @@ docker run --rm relizaio/rearm-cli \
225
225
226
226
Flags stand for:
227
227
228
-
-**getlatestrelease** - command that denotes we are requesting latest release data for Component or Bundle from ReARM
228
+
-**getlatestrelease** - command that denotes we are requesting latest release data for Component or Product from ReARM
229
229
-**-i** - flag for api id which can be either api id for this component or organization-wide read API (required).
230
230
-**-k** - flag for api key which can be either api key for this component or organization-wide read API (required).
231
-
-**--component** - flag to denote UUID of specific Component or Bundle, UUID must be obtained from [ReARM](https://relizahub.com) (optional if component api key is used, otherwise required).
232
-
-**--bundle** - flag to denote UUID of Bundle which packages Component or Bundle for which we inquiry about its version via --component flag, UUID must be obtained from [ReARM](https://relizahub.com) (optional).
233
-
-**--branch** - flag to denote required branch of chosen Component or Bundle (optional, if not supplied settings from ReARM UI are used).
231
+
-**--component** - flag to denote UUID of specific Component or Product, UUID must be obtained from [ReARM](https://relizahub.com) (optional if component api key is used, otherwise required).
232
+
-**--product** - flag to denote UUID of Product which packages Component or Product for which we inquiry about its version via --component flag, UUID must be obtained from [ReARM](https://relizahub.com) (optional).
233
+
-**--branch** - flag to denote required branch of chosen Component or Product (optional, if not supplied settings from ReARM UI are used).
234
234
-**--env** - flag to denote environment to which release approvals should match. Environment can be one of: DEV, BUILD, TEST, SIT, UAT, PAT, STAGING, PRODUCTION. If not supplied, latest release will be returned regardless of approvals (optional).
235
235
-**--tagkey** - flag to denote tag key to use as a selector for artifact (optional, if provided tagval flag must also be supplied). Note that currently only single tag is supported.
236
236
-**--tagval** - flag to denote tag value to use as a selector for artifact (optional, if provided tagkey flag must also be supplied).
@@ -300,7 +300,7 @@ Flags stand for:
300
300
-**-i** - flag for org api id (required).
301
301
-**-k** - flag for org api key (required).
302
302
-**name** - flag to denote component name (required).
303
-
-**type** - flag to denote component type (required). Supported values: component, bundle.
303
+
-**type** - flag to denote component type (required). Supported values: component, product.
304
304
-**defaultbranch** - flag to denote default branch name (optional, if not set "main" will be used). Available names are either main or master.
305
305
-**versionschema** - flag to denote version schema (optional, if not set "semver" will be used). [Available version schemas](https://github.com/relizaio/versioning).
306
306
-**featurebranchversioning** - flag to denote feature branch version schema (optional, if not set "Branch.Micro will be used).
downloadableArtifactCmd.PersistentFlags().StringVar(&releaseId, "releaseid", "", "UUID of release (either releaseid or releaseversion and component must be set)")
1434
1433
downloadableArtifactCmd.PersistentFlags().StringVar(&releaseVersion, "releaseversion", "", "Version of release (either releaseid or releaseversion and component must be set)")
1435
-
downloadableArtifactCmd.PersistentFlags().StringVar(&component, "component", "", "UUID of component or bundle for release (either instance and component or releaseid or releaseversion and component must be set)")
1434
+
downloadableArtifactCmd.PersistentFlags().StringVar(&component, "component", "", "UUID of component or product for release (either instance and component or releaseid or releaseversion and component must be set)")
1436
1435
downloadableArtifactCmd.PersistentFlags().StringVarP(&filePath, "file", "f", "", "Path to the artifact")
1437
1436
// downloadableArtifactCmd.PersistentFlags().StringVar(&odelType, "odelType", "GENERIC", "Type of artifact - can be (TEST_REPORT, SECURITY_SCAN, DOCUMENTATION, GENERIC) or some user defined value")
1438
1437
1439
1438
// flags for createcomponent command
1440
1439
createComponentCmd.PersistentFlags().StringVar(&componentName, "name", "", "Name of component to create")
createComponentCmd.PersistentFlags().StringVar(&defaultBranch, "defaultbranch", "main", "Default branch name of component, default set to main. Available names are either main or master.")
1445
1444
createComponentCmd.PersistentFlags().StringVar(&versionSchema, "versionschema", "semver", "Version schema of component, default set to semver. Available version schemas: https://github.com/relizaio/versioning")
0 commit comments