Build & Release
Build Docker Image
To build a Docker image one can execute the ./build-docker-image.ts file. This can also be achieved by executing one of the following npm scripts: docker:build and docker:build:pre. For more information see the section below.
Script parameters
The build-docker-image.ts script takes in the following parameters but all are optional. If the parameter itself needs a value the value has to be put after a = (ie --version=2.0.0). The image will be tagged with "ghcr.io/dudrie/tutor-management-system" as a name followed by the version from the root package.json by default.
| Parameter | Short | Description |
|---|---|---|
--version= | -v= | Overrides the version used for the image tag. Must be followed by the semantic version which should be used (ie -v=2.0.1) |
--pre | - | If provided the image tag will get a -pre suffix after the version ("ghcr.io/dudrie/tutor-management-system:2.0.1-pre") |
--bundle | - | The image will get bundled into a .tar file. |
--no-version-in-tar-name | - | The generated .tar file will not contain the version of the image tag. |
Npm scripts
docker:build
This will run the build-docker-image.ts script.
One can specify all the parameters above for this script aswell.
If you run pnpm run docker:build you can pass in the parameters after a --:
pnpm run docker:build -- <additional params>
The PowerShell on Windows treats the -- in a special manner: It simply removes it from the command.
You have to wrap it in "" (like "--") to use it inside the PowerShell.
Otherwise, pnpm will throw an error.
docker:build:pre
Executes the build-docker-image.ts script with the --pre parameter.
Additional parameters can be provided aswell (see above).
docker:build:tar
Executes the build-docker-image.ts script with the --bundle parameter.
Additional parameters can be provided aswell (see above).
Release
Upon publishing a new release the Build and push Docker image workflow is triggered.
It will build a corresponding docker image using the tag of the release as image tag.
Afterwards this image is pushed to the GitHub container repository of the Tutor-Management-System repository.
For more information visit the GitHub workflow page.
The script itself will bump the version internally to the tag of the release. However, this bump will not be pushed back into the repository.