Automate release preparation process #1710
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Due Diligence
Description
Summary
This PR introduces a new GitHub Actions workflow named "Prep Heat Release". The workflow is designed to automate the process of preparing a release for the Heat project.
Motivation
The goal of this workflow is to streamline the release preparation process by automating version extraction, branch creation, and version bumping. This reduces manual effort and minimizes the risk of human error.
Workflow Details
The workflow is triggered when an issue is opened with the label
release-prep. A dedicated issue template has been added to the repo.Impact
These changes will automate the release preparation process. It will create new release branches if needed, and update version numbers automatically based on the issue title. It will create a PR where further (manual) work can be collected.
The resulting PR looks like this.
Issue/s resolved: #1709
Changes proposed:
.github/ISSUE_TEMPLATE/release_prep.mdto guide users through the process of triggering the release preparation workflow..github/workflows/release-prep.yamlto automate the release preparation process, including extracting version information, creating release branches, updating version numbers, and creating pull requests.RELEASE.mdto reflect the new automated release preparation process, including instructions on how to trigger the workflow, update version numbers, and publish releases. [1] [2] [3]RELEASE.md.Type of change
Automation and docs update
Memory requirements
Performance
Does this change modify the behaviour of other functions? If so, which?
no