Merge pull request #129 from philips-software/add-documentation-on-automated-versions

Add example on major, minor, and patch releases.

Author: JeroenKnoops

README.md

@@ -1,21 +1,21 @@
 <div align="center">
 
-# GitHub Action for creating and publishing docker images 
+# GitHub Action for creating and publishing docker images
 
 [![Marketplace](https://img.shields.io/badge/GitHub-Marketplace-green.svg)](https://github.com/marketplace/actions/docker-build-and-publish) [![Release](https://img.shields.io/github/release/philips-software/docker-ci-scripts.svg)](https://github.com/philips-software/docker-ci-scripts/releases)
 
-This action will build a docker image from a given directory. 
+This action will build a docker image from a given directory.
 </div>
 
 - You can give a docker image multiple tags.
-- You can specify for which branch it should push to a docker registry ( `docker.io` by default ). 
+- You can specify for which branch it should push to a docker registry ( `docker.io` by default ).
 - Each docker image contains information about the exact context in which the image is build.
 - When pushing to docker.io, the description is updated with the `readme.md` file.
 - If required, the image is signed with [cosign](https://github.com/sigstore/cosign).
-- If required, a provenance file is created according to the [SLSA.dev](https://slsa.dev) specifications. 
-- If required, the provenance file is attached to the container. 
+- If required, a provenance file is created according to the [SLSA.dev](https://slsa.dev) specifications.
+- If required, the provenance file is attached to the container.
 - If required, a SBOM file is created according to the [SPDX](https://spdx.dev) specifications. We're using [VMWare Tern](https://github.com/tern-tools/tern) for that. (very slow at the moment)
-- If required, the SBOM file is attached to the container. 
+- If required, the SBOM file is attached to the container.
 
 In every docker image two files are added to the build context:
 * `TAGS` - contains all tags associated with the image at time it was build.
@@ -69,26 +69,26 @@ Builds docker images and publish them on request
 
 These variables can be set in the github repository secret vault.
 
-### `DOCKER_USERNAME` 
+### `DOCKER_USERNAME`
 
 **Required** Docker username
 
-### `DOCKER_PASSWORD` 
+### `DOCKER_PASSWORD`
 
 **Required**  Docker password
 
-### `DOCKER_REGISTRY` 
+### `DOCKER_REGISTRY`
 
 **Optional** Registry to push the docker image to. Defaults to Docker hub.
 
-### `DOCKER_ORGANIZATION` 
+### `DOCKER_ORGANIZATION`
 
 **Required for Docker hub** Container will be pushed in this organization. Example: `philipssoftware`
 No need to put this in GitHub Secret vault. This will be public anyway.
 
-### `GITHUB_ORGANIZATION` 
+### `GITHUB_ORGANIZATION`
 
-**Optional** Github organization. Defaults to DOCKER_ORGANIZATION. Example: `philips-software` 
+**Optional** Github organization. Defaults to DOCKER_ORGANIZATION. Example: `philips-software`
 No need to put this in GitHub Secret vault. This will be public anyway.
 
 ### `COSIGN_PRIVATE_KEY`
@@ -276,7 +276,7 @@ You can inspect the provenance and decide on whether you want use the image.
     DOCKER_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
     DOCKER_REGISTRY: ghcr.io/organization-here
     GITHUB_ORGANIZATION: organization-here
-- name: Show SBOM 
+- name: Show SBOM
   run: |
     cat ${{ steps.docker.outputs.sbom-file }}
 ```
@@ -349,6 +349,44 @@ $ cosign verify-attestation --key cosign.pub jeroenknoops/test-image:latest | jq
 This is nice, because you can see the SBOM of the image, without downloading it!
 You can inspect the SBOM and decide on whether you want use the image.
 
+#### Automatically create major minor and patch versions
+
+Sometimes you want to automatically create major, minor and patch releases for certain tags in the repository.
+For example when you create a git tag: `v2.32.1` you might want to automatically create versions: `2`, `2.32`, and `2.32.1`.
+
+This can be done with a small snippet:
+
+```yaml
+- name: SplitTag
+  if: startsWith(github.ref, 'refs/tags/v')
+  run: |
+    refIN=${GITHUB_REF##*/}
+    arrIN=(${refIN//./ })
+    echo "major=${arrIN[0]}" >> $GITHUB_ENV
+    echo "minor=${arrIN[0]}.${arrIN[1]}" >> $GITHUB_ENV
+    echo "patch=${arrIN[0]}.${arrIN[1]}.${arrIN[2]}" >> $GITHUB_ENV
+
+- name: Set no tag
+  if: startsWith(github.ref, 'refs/tags/v') == false
+  run: |
+    echo "major=" >> $GITHUB_ENV
+    echo "minor=" >> $GITHUB_ENV
+    echo "patch=" >> $GITHUB_ENV
+
+- uses: philips-software/docker-ci-scripts@v4.2.0
+  with:
+    dockerfile: './docker/Dockerfile'
+    image-name: 'node'
+    tags: 'latest ${{ env.major }} ${{ env.minor }} ${{ env.patch }}'
+    push-on-git-tag: 'true'
+  env:
+    DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+    DOCKER_PASSWORD: '${{ secrets.DOCKER_PASSWORD }}'
+    DOCKER_ORGANIZATION: myDockerOrganization
+```
+
+Thanks to [@daantimmer](https://github.com/daantimmer) to provide this snippet.
+
 ## Example projects
 
 * [philips-software/docker-node](https://github.com/philips-software/docker-node)
@@ -361,7 +399,7 @@ You can inspect the SBOM and decide on whether you want use the image.
 ## Breaking changes v3.0.0
 
 The `docker build` command is now being called from the root of the project
-instead of the directory. 
+instead of the directory.
 
 This has impact when your project has these two things:
 - Directories with dockerfiles
@@ -370,7 +408,7 @@ This has impact when your project has these two things:
 You now need to change the path to include the directory.
 
 Example:
-- `ADD /scripts/entrypoint.sh entrypoint.sh` becomes: `ADD /6/java/scripts/entrypoint.sh entrypoint` 
+- `ADD /scripts/entrypoint.sh entrypoint.sh` becomes: `ADD /6/java/scripts/entrypoint.sh entrypoint`
 
 ## Contributors