From 590315aa7f9cf8ab0062d4a2c5eddc0c95d6d67c Mon Sep 17 00:00:00 2001 From: Marco Ferrari Date: Thu, 29 Sep 2022 20:15:55 +0200 Subject: [PATCH] Update release instructions with details about Git tags (#3375) --- docs/release-process.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/release-process.md b/docs/release-process.md index b3a724c5..2d9242ab 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -9,19 +9,21 @@ The Process to create a `Release` of the **GitHub/Super-Linter** is as follows: - This also causes the `Release drafter` action to update a new draft Release When an *Admin* wants to create a Release, the process is as follows: + - The *Admin* pushes an update to `master/main` and updates the `action.yml` to point to the next **Release** version - Example: `image: 'docker://ghcr.io/github/super-linter:v4.6.2'` becomes: `image: 'docker://ghcr.io/github/super-linter:v4.6.3'` - Then the *admin* can go to the Release page and update the current `draft Release` - The *Admin* will set the correct version strings, and update any additional information in the current `draft Release` - Once the *Admin* is ready, they will select **Publish Release** - This triggers the **GitHub Actions** to take the current codebase, and build the containers, and deploy to their locations -- This creates the following images: +- This creates and pushes the following container images: - `github/super-linter:latest` - `github/super-linter:v4` - `github/super-linter:v4.6.3` - `github/super-linter:slim-latest` - `github/super-linter:slim-v4` - `github/super-linter:slim-v4.6.3` +- The `versioning.yml` workflow is also triggered to update the `latest` and `vMAJOR` Git tags to point to the same commit that the release Git tag is pointing at. - At this point, the Release is complete and images are available for general consumption ## Pitfalls and Issues