2023-12-20 08:58:25 -05:00
|
|
|
# Super-Linter releases
|
2021-08-31 13:31:54 -04:00
|
|
|
|
2023-12-20 08:58:25 -05:00
|
|
|
The Process to create a super-linter release is as follows:
|
2021-08-31 13:31:54 -04:00
|
|
|
|
2023-12-20 08:58:25 -05:00
|
|
|
1. Merge the release pull request.
|
|
|
|
|
|
2023-12-21 09:03:14 -05:00
|
|
|
## Preview the release pull request
|
|
|
|
|
|
2024-09-13 08:37:48 -04:00
|
|
|
In order to have a preview of the next release before merging a pull request
|
|
|
|
|
that updates the configuration of the tooling that we use to create releases, do
|
|
|
|
|
the following:
|
2023-12-21 09:03:14 -05:00
|
|
|
|
|
|
|
|
1. Run:
|
|
|
|
|
|
2024-08-15 04:21:26 -04:00
|
|
|
```shell
|
|
|
|
|
make release-please-dry-run
|
|
|
|
|
```
|
2023-12-21 09:03:14 -05:00
|
|
|
|
|
|
|
|
This command also runs as part of the [CI process](../.github/workflows/ci.yml).
|
|
|
|
|
|
2023-12-20 08:58:25 -05:00
|
|
|
## Release workflows
|
2021-08-31 13:31:54 -04:00
|
|
|
|
2023-12-20 08:58:25 -05:00
|
|
|
Every push to the default branch triggers GitHub Actions workflows that:
|
|
|
|
|
|
|
|
|
|
- Build and deploy of super-linter container images:
|
2022-09-29 14:15:55 -04:00
|
|
|
|
2023-08-17 11:12:11 -04:00
|
|
|
- `super-linter/super-linter:latest`
|
|
|
|
|
- `super-linter/super-linter:slim-latest`
|
2021-08-31 13:31:54 -04:00
|
|
|
|
2023-12-21 09:03:14 -05:00
|
|
|
- Update the next release pull request.
|
|
|
|
|
|
|
|
|
|
## Release automation tooling
|
|
|
|
|
|
|
|
|
|
In order to automate releases, we use
|
|
|
|
|
[release-please](https://github.com/googleapis/release-please).
|
|
|
|
|
|
|
|
|
|
We configure release-please using two files:
|
|
|
|
|
|
|
|
|
|
- [release-please configuration file](../.github/release-please/release-please-config.json):
|
|
|
|
|
contains release-please configuration.
|
|
|
|
|
- [release-please manifest file](../.github/release-please/.release-please-manifest.json):
|
|
|
|
|
contains information about the current release.
|
