Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
Signed-off-by: Alfredo Gutierrez <[email protected]>
  • Loading branch information
AlfredoG87 committed Aug 8, 2024
1 parent 8440d84 commit 2fd1bdb
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ This document outlines the release process for our project, detailing the steps
1. **Milestone and Label Check**:
- Ensure all Pull Requests (PRs) have a milestone set and appropriate labels. This is important for generating accurate release notes.
- There is a CI check to ensure that all PRs have a milestone and labels set. If not, the PR will not be merged.
- Make sure all PRs and Issues related to the related milestone are already closed, if not closed them before proceeding or move them to the next milestone.
- Make sure all PRs and Issues related to the related milestone are already closed, if not closed them before proceeding or move them to the next milestone.
2. **Trigger Release Automation Workflow**:
- Manually trigger the `release-automation.yaml` workflow with the desired version to be released.
- The workflow will create a new release branch, bump the version, and tag the release.
- The release branch will be used for any patch versions or hot-fixes.
- If the release branch already exists, the workflow should be triggered using the branch release, and the version should be bumped accordingly.
- for example: if `release/0.1` exists, and you want to release `0.1.1`, trigger the workflow with `0.1.1` as the semver input and select `release/0.1` on "Use workflow from" dropdown.

### Release Automation Workflow

Expand Down

0 comments on commit 2fd1bdb

Please sign in to comment.