Skip to content

Commit 40dc31d

Browse files
committed
docs: update README.md
1 parent 6761498 commit 40dc31d

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,35 @@
11
# sample-gitflow-release-workflows
22

3-
Sample Gitflow release workflow using GitHub Actions.
3+
[![Release](https://img.shields.io/github/release/ansidev/sample-gitflow-release-workflows.svg)](https://github.com/ansidev/sample-gitflow-release-workflows/releases)
4+
[![Build Status](https://github.com/ansidev/sample-gitflow-release-workflows/workflows/release/badge.svg)](https://github.com/ansidev/sample-gitflow-release-workflows/actions)
5+
6+
Sample Gitflow release workflow using GitHub Actions and official [GitHub CLI](https://cli.github.com/manual/).
7+
8+
## Features
9+
10+
- Auto create and publish a new release on merging changes from `release/**`/`hotfix/**` into `main`.
11+
- Auto create corresponding git tag with the released version.
12+
- Auto create PR and merge changes from `release/**`/`hotfix/**` back into `develop`.
413

514
## Manual
615

7-
- Workflow definitions: [release.yaml](./.github/workflows/release.yaml)
8-
- You have to update two env variables: `BRANCH_MAIN`, `BRANCH_DEVELOP` if necessary.
16+
- Workflows
17+
18+
| Name | Description | File |
19+
| ------- | ------------------ | ------------------------------------------------ |
20+
| Release | Automate releasing | [release.yaml](./.github/workflows/release.yaml) |
21+
22+
- You have to update below env variables if necessary
23+
24+
| Environment variable | Description | Default value |
25+
| -------------------- | ---------------------- | ------------- |
26+
| BRANCH_MAIN | The main branch | `main` |
27+
| BRANCH_DEVELOP | The develop branch | `develop` |
28+
| TAG_PREFIX | The prefix for git tag | `v` |
29+
30+
## Contact
31+
32+
Le Minh Tri [@ansidev](https://ansidev.xyz/about).
933

1034
## License
1135

0 commit comments

Comments
 (0)