Skip to content

Commit 004138d

Browse files
issue #20, fix documentation (#23)
1 parent af6499a commit 004138d

File tree

4 files changed

+14
-9
lines changed

4 files changed

+14
-9
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@ containers to get consistent build results in your local development environment
1010

1111
To allow hosting of multiple container builds from a single repo each toolchain container
1212
is assigned a prefix. For every release event in this repo the workflow triggered is based
13-
on that prefix in the release tag. For example, by creating a release with the tag `tsv18.4.1-alpha`
14-
the release workflow for the `toolshed` container will be triggered (note that the 'v' in 'tsv' will be
15-
elided by the release action).
13+
on that prefix in the release tag. For example, by creating a release with the tag `ts18.4.1-alpha`
14+
the release workflow for the `toolshed` container will be triggered.
1615

1716
### opencyphal/toolshed:ts
1817

@@ -82,3 +81,9 @@ jobs:
8281
runs-on: ubuntu-latest
8382
container: ghcr.io/opencyphal/toxic:tx20.4.1
8483
```
84+
85+
---------------------------
86+
87+
Note that, if you create a new container in this project, the prefix cannot end with 'v'. So "tu22.4.1" is okay but
88+
"tv28.3.1" won't work because the release workflows elide "v" (as in version) by default and the container will become
89+
"t28.3.1" in packages but "tv.28.3.1" as a git tag.

texer/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ and publication of OpenCyphal [LaTeX](https://www.latex-project.org/) documents.
77

88
To release a new build of this container simply create a [new github release](https://github.com/OpenCyphal/docker_toolchains/releases/new)
99
that starts with `te`, uses the Ubuntu major and minor version, and uses an monotonically increasing "patch" version.
10-
For example `tev20.4.1`will cause the Github workflow to rebuild and push the `opencyphal/texer` container with the
11-
tag `te20.4.1` (where the release workflow elides the 'v').
10+
For example `te20.4.1`will cause the Github workflow to rebuild and push the `opencyphal/texer` container with the
11+
tag `te20.4.1`.
1212

1313
***PLEASE UPDATE THE TOP-LEVEL README.md FOR EACH NEW RELEASE***
1414

toolshed/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ for development, continuous-integration, and test automation of C and C++ based
77

88
To release a new build of this container simply create a [new github release](https://github.com/OpenCyphal/docker_toolchains/releases/new)
99
that starts with `ts`, uses the Ubuntu major and minor version, and uses an monotonically increasing "patch" version.
10-
For example `tsv20.4.1`will cause the Github workflow to rebuild and push the `opencyphal/toolshed` container with the
11-
tag `ts20.4.1` (where the release workflow elides the 'v').
10+
For example `ts20.4.1`will cause the Github workflow to rebuild and push the `opencyphal/toolshed` container with the
11+
tag `ts20.4.1`.
1212

1313
***PLEASE UPDATE THE TOP-LEVEL README.md FOR EACH NEW RELEASE***
1414

toxic/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ for development, continuous-integration, and test automation of Python based pro
77

88
To release a new build of this container simply create a [new github release](https://github.com/OpenCyphal/docker_toolchains/releases/new)
99
that starts with `tx`, uses the Ubuntu major and minor version, and uses an monotonically increasing "patch" version.
10-
For example `txv20.4.1`will cause the Github workflow to rebuild and push the `opencyphal/toxic` container with the
11-
tag `tx20.4.1` (where the release workflow elides the 'v').
10+
For example `tx20.4.1`will cause the Github workflow to rebuild and push the `opencyphal/toxic` container with the
11+
tag `tx20.4.1`.
1212

1313
***PLEASE UPDATE THE TOP-LEVEL README.md FOR EACH NEW RELEASE***
1414

0 commit comments

Comments
 (0)