actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-25 02:01:02 -05:00
Code Issues Projects Releases Packages Wiki Activity

Update release instructions with details about Git tags (#3375)

Browse source
This commit is contained in:
Marco Ferrari 2022-09-29 20:15:55 +02:00 committed by GitHub
parent 84c0d52acc
commit 590315aa7f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/release-process.md
View file

@ -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 - 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: 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 - 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'` - 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` - 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` - 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** - 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 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:latest`
- `github/super-linter:v4` - `github/super-linter:v4`
- `github/super-linter:v4.6.3` - `github/super-linter:v4.6.3`
- `github/super-linter:slim-latest` - `github/super-linter:slim-latest`
- `github/super-linter:slim-v4` - `github/super-linter:slim-v4`
- `github/super-linter:slim-v4.6.3` - `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 - At this point, the Release is complete and images are available for general consumption
## Pitfalls and Issues ## Pitfalls and Issues