superlint/docs/release-process.md
Marco Ferrari 641c65a8c4
ci: configure release-please dry-run and changelog (#5039)
- Implement a job to preview the release notes
- Include build, ci, and dependency updates
- Add emoji to section headings to match the existing release notes
- Add documentation about how to run release-please from the CLI
2023-12-21 15:03:14 +01:00

42 lines
1.2 KiB
Markdown

# Super-Linter releases
The Process to create a super-linter release is as follows:
1. Merge the release pull request.
## Preview the release pull request
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:
1. Run:
```shell
make release-please-dry-run
```
This command also runs as part of the [CI process](../.github/workflows/ci.yml).
## Release workflows
Every push to the default branch triggers GitHub Actions workflows that:
- Build and deploy of super-linter container images:
- `super-linter/super-linter:latest`
- `super-linter/super-linter:slim-latest`
- 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.