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
Copy file name to clipboardexpand all lines: README.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ This repository contains the scripts that build the ContainerSSH container image
11
11
12
12
This repository contains a build script in Go called `build.go`. It can be invoked by running `go run build.go`. This script will read [build.yaml](build.yaml) and build the container image based on that revision. It uses the GitHub API to download release artifacts, so it may need the `GITHUB_TOKEN` environment variable set. The optional `--push` flag can be set to push the images to the corresponding registries.
13
13
14
-
Under the hood the build uses [`docker-compose`](https://docs.docker.com/compose/) to build, test, and push the images. The build steps can be performed manually.
14
+
Under the hood the build uses [`dockercompose`](https://docs.docker.com/compose/) to build, test, and push the images. The build steps can be performed manually.
15
15
16
16
Before you begin you must set several environment variables. These are the following:
17
17
@@ -26,15 +26,15 @@ Before you begin you must set several environment variables. These are the follo
26
26
For example, on Linux/MacOS:
27
27
28
28
```bash
29
-
CONTAINERSSH_VERSION="0.3.1"
30
-
CONTAINERSSH_TAG="0.3.1"
29
+
CONTAINERSSH_VERSION="v0.5.2"
30
+
CONTAINERSSH_TAG="v0.5.2"
31
31
```
32
32
33
33
On Windows/PowerShell:
34
34
35
35
```ps1
36
-
$env:CONTAINERSSH_VERSION="0.3.1"
37
-
$env:CONTAINERSSH_TAG="0.3.1"
36
+
$env:CONTAINERSSH_VERSION="v0.5.2"
37
+
$env:CONTAINERSSH_TAG="v0.5.2"
38
38
```
39
39
40
40
### Build
@@ -44,29 +44,29 @@ The build step requires build arguments to function. At the very least it should
44
44
Optionally, you can also specify a `GITHUB_TOKEN` to work around GitHub rate limits and `SOURCE_REPO` to point the build to a different source URL.
45
45
46
46
```bash
47
-
docker-compose build
47
+
dockercompose build
48
48
```
49
49
50
50
### Test
51
51
52
52
Testing is done via a container called `sut`. This container will wait for ContainerSSH to come up and then run a simple SSH connection to it to test that it works correctly. This is not a comprehensive test, but checks if the image build was successful.
53
53
54
54
```
55
-
docker-compose up --abort-on-container-exit --exit-code-from=sut
55
+
dockercompose up --abort-on-container-exit --exit-code-from=sut
56
56
```
57
57
58
58
### Clean up after test
59
59
60
60
```
61
-
docker-compose down
61
+
dockercompose down
62
62
```
63
63
64
64
### Push
65
65
66
-
Finally, pushing container images can also be done from `docker-compose`. After a `docker login` command this can be simply done using the following command:
66
+
Finally, pushing container images can also be done from `dockercompose`. After a `docker login` command this can be simply done using the following command:
0 commit comments