This repository is for automating Longhorn releases through GitHub actions, including regular releases, preview releases, and sprint releases. Additionally, it also supports some extra repository and CI operations.
To create a release, run a release workflow. The common steps for each workflow are outlined below, though they may vary slightly for different release types. For the precise steps, please refer to the workflow file for each release type.
- Set up the git environment.
- Clone this repository.
- Retrieve branch, tag, and milestone parameters of the planned release.
- Update the version file in each branch-based repository.
- Create and merge a release pull request for longhorn/longhorn and longhorn/chart repositories separately.
- Gather artifacts, including charts.tar.gz and longhorn-images.txt.
- Create a tag for each branch-based repository.
- Generate a changelog.
- Create a draft release note on longhorn/longhorn until branch-based images are successfully built.
How to do if a failure happens during the release?
If any step fails, rerun the process after resolving the failure. For step 7, the tag of each repository branch will be recreated automatically, eliminating the need for manual intervention before rerunning the workflow, except for deleting the already created draft release on longhorn/longhorn.
If any image build fails on https://drone-publish.longhorn.io/, which is our build service for creating and publishing Longhorn container images to Docker Hub, resolve the issue or rerun the failed build if it's flaky. Additionally, create a ticket for the flaky issue and share it with the team.
What is the next after the workflow is complete?
After the workflow is completed, the draft release is ready. Update it if necessary, and publish it as a preview or regular release if it's generally available.
Run the Release workflow by providing the following parameters.
| Parameter | Example |
|---|---|
| Branch:Tag:Milestone:PreviousTag | v1.6.x:v1.6.0-rc1:v1.6.0:v1.5.0 |
Check the workflow file to understand the detailed steps.
Run the Release - Preview workflow by providing the following parameters.
| Parameter | Example |
|---|---|
| Branch:Tag:Milestone:PreviousTag | v1.6.x:v1.6.0-rc1:v1.6.0:v1.5.0 |
Check the workflow file to understand the detailed steps.
Run the Release - Sprint workflow by providing the following parameters. This will be set to automatically run on a (bi)weekly cadence.
Check the workflow file to understand the detailed steps.