|
1 | 1 | # IBM Garage command-line tools |
2 | 2 |
|
3 | 3 | This repository builds a Docker image whose container is a client for using IBM Cloud. |
4 | | -The container includes the following tools: |
5 | | -- terraform cli |
| 4 | + |
| 5 | +The container includes the following tools - (tool@version): |
| 6 | +- terraform cli@0.12.23 |
6 | 7 | - terraform plugins: |
7 | | - - terraform-provider-helm |
8 | | - - terraform-provider-kube |
9 | | - - terraform-provider-ibm |
10 | | -- calico cli |
| 8 | + - terraform-provider-helm@1.0.0 |
| 9 | + - terraform-provider-kube@1.10.0 |
| 10 | + - terraform-provider-ibm@1.2.3 |
| 11 | +- calico cli@3.12.0 |
11 | 12 | - ibmcloud cli |
12 | 13 | - ibmcloud plugins: |
13 | 14 | - container-service |
14 | 15 | - container-registry |
15 | 16 | - cloud-databases |
16 | | -- docker cli |
17 | | -- kubectl cli |
| 17 | +- kubectl cli@1.15.5 |
18 | 18 | - kustomize cli |
19 | 19 | - openshift (oc) cli |
20 | | -- helm cli |
| 20 | +- helm2 cli |
| 21 | +- helm3 cli |
21 | 22 | - git cli |
22 | | -- nvm cli |
23 | | -- node cli |
| 23 | +- nvm cli@0.35.2 |
| 24 | +- node cli@12.x |
24 | 25 | - npm cli |
25 | | -- solsa cli |
| 26 | +- solsa cli@0.3.5 |
26 | 27 | - yeoman (yo) cli |
27 | 28 |
|
28 | 29 | The container also includes the following helper scripts: |
@@ -51,12 +52,12 @@ Start the client to use it. |
51 | 52 | - To run the `icclient` container: |
52 | 53 |
|
53 | 54 | ```bash |
54 | | - docker run -itd --name icclient garagecatalyst/ibm-garage-cli-tools |
| 55 | + docker run -itd --name icclient ibmgaragecloud/cli-tools |
55 | 56 | ``` |
56 | 57 |
|
57 | 58 | This assumes the image's default name, `ibm-garage-cli-tools`. |
58 | 59 |
|
59 | | -Once the client is running in the backgroud, use it by opening a shell in it. |
| 60 | +Once the client is running in the backgroud, use it by opening a shell into it. |
60 | 61 |
|
61 | 62 | - To use the `icclient` container, exec shell into it: |
62 | 63 |
|
@@ -198,14 +199,21 @@ the image. Configuration for these tests are provided in the aptly named `config |
198 | 199 | See https://github.com/GoogleContainerTools/container-structure-test for information on the |
199 | 200 | defined values for the test definition. |
200 | 201 |
|
201 | | -#### Push the image to Docker Hub |
| 202 | +#### Releasing the a version to Docker Hub |
| 203 | +
|
| 204 | +A build pipeline is configured in Docker Hub to create new image versions when a change is pushed to Git. A new `latest` tag will be put on the tip of `master` branch and a |
| 205 | +versioned image tag will be created off of Git tags. |
| 206 | +
|
| 207 | +In order to release a new version of the code for build, run the following: |
202 | 208 |
|
203 | 209 | ```bash |
204 | | -npm run push |
| 210 | +export GITHUB_TOKEN="<github PAT>" |
| 211 | +npm run release |
205 | 212 | ``` |
206 | 213 |
|
207 | | -This will tag the local image version with the `IMAGE_ORG`/`IMAGE_NAME`:`IMAGE_VERSION` |
208 | | -tag and push it to Docker Hub. |
| 214 | +...and follow the on screen instructions |
| 215 | +
|
| 216 | +**Note:** The GITHUB_TOKEN should be your personal access token for GitHub. It is needed in order to create the `release` documentation in the repo |
209 | 217 |
|
210 | 218 | #### Configuration |
211 | 219 |
|
|
0 commit comments