Skip to content

Commit 9175012

Browse files
committed
docs: update README.md
1 parent c539237 commit 9175012

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,25 @@ Sample Gitflow release workflow using GitHub Actions and official [GitHub CLI](h
77

88
## Features
99

10-
- Auto create and publish a new release on merging changes from `release/**`/`hotfix/**` into `main`.
10+
- Auto create a draft PR on pushing new branch `release/**` or `hotfix/**`.
11+
- Auto add following labels for PR:
12+
- `automated-pr`,
13+
- `release-pr`: if normal release.
14+
- `hotfix-pr`: if hotfix release.
15+
- `pre-release`: if version contains `alpha`, `beta`, `rc`.
16+
- **Note:** You are responsible for preparing release materials: changelog, bump version,... using your favorite tools.
17+
- Auto create and publish a new release on merging changes from `release/**` or `hotfix/**` into `main`.
1118
- Auto create corresponding git tag with the released version.
12-
- Auto create PR and merge changes from `release/**`/`hotfix/**` back into `develop`.
19+
- Auto create PR and merge changes from `release/**` or `hotfix/**` back into `develop`.
1320

1421
## Manual
1522

1623
- Workflows
1724

18-
| Name | Description | File |
19-
| ------- | ------------------ | ------------------------------------------------ |
20-
| Release | Automate releasing | [release.yaml](./.github/workflows/release.yaml) |
25+
| Name | Description | File |
26+
| ----------------------- | ------------------------------ | -------------------------------------------------------------------------------- |
27+
| Release | Automate releasing | [release.yaml](./.github/workflows/release.yaml) |
28+
| Draft Release/Hotfix PR | Automate drafting a release PR | [draft_release_hotfix_pr.yaml](./.github/workflows/draft_release_hotfix_pr.yaml) |
2129

2230
- You have to update below env variables if necessary
2331

0 commit comments

Comments
 (0)