Skip to content

Commit df93577

Browse files
committed
Document release process
1 parent 1c92b76 commit df93577

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,12 @@ If you would like to contribute, here are some notes and guidelines:
99
- All code changes must be validated by `composer check`
1010
- [Helpful article about forking](https://help.github.com/articles/fork-a-repo/ "Forking a GitHub repository")
1111
- [Helpful article about pull requests](https://help.github.com/articles/using-pull-requests/ "Pull Requests")
12+
13+
## How to release
14+
15+
1. Complete CHANGELOG.md and commit
16+
2. Create an annotated tag
17+
1. `git tag -a 1.2.3`
18+
2. Tag subject must be the version number, eg: `1.2.3`
19+
3. Tag body must be a copy-paste of the changelog entries
20+
3. Push tag with `git push --tags`, GitHub Actions will create a GitHub release automatically

0 commit comments

Comments
 (0)