Skip to content

Commit b5d7d50

Browse files
committed
docs(changelog): Add instructions to update CHANGELOG.md
1 parent 56c908b commit b5d7d50

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,12 @@ feat: create initial CONTRIBUTING.md
6666
This closes #73
6767
```
6868

69-
> **NOTE:** [CHANGELOG.md](CHANGELOG.md) is generated based on the commits.
69+
## Release process
70+
71+
Example for version `v1.7.0`
72+
73+
1. Bump the version in `lib/omniauth-saml/version.rb`
74+
1. Update [CHANGELOG.md](CHANGELOG.md) with `bundle exec conventional-changelog version=v1.7.0 since_version=v1.6.0`
75+
1. Commit all your changes
76+
1. Tag the latest commit with `git tag v1.7.0`
77+
1. Contact the maintainers

0 commit comments

Comments
 (0)