Skip to content

Commit cc5759d

Browse files
committed
fix(release): manually release a major version
There was an issue with a major release, so this manual-releases.md change is to release a new major version. Reference: #261 BREAKING CHANGE: I will fix up these notes soon.
1 parent 080a859 commit cc5759d

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

other/manual-releases.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# manual-releases
2+
3+
This project has an automated release set up. So things are only released when
4+
there are useful changes in the code that justify a release. But sometimes
5+
things get messed up one way or another and we need to trigger the release
6+
ourselves. When this happens, simply bump the number below and commit that with
7+
the following commit message based on your needs:
8+
9+
**Major**
10+
11+
```
12+
fix(release): manually release a major version
13+
14+
There was an issue with a major release, so this manual-releases.md
15+
change is to release a new major version.
16+
17+
Reference: #<the number of a relevant pull request, issue, or commit>
18+
19+
BREAKING CHANGE: <mention any relevant breaking changes (this is what triggers the major version change so don't skip this!)>
20+
```
21+
22+
**Minor**
23+
24+
```
25+
feat(release): manually release a minor version
26+
27+
There was an issue with a minor release, so this manual-releases.md
28+
change is to release a new minor version.
29+
30+
Reference: #<the number of a relevant pull request, issue, or commit>
31+
```
32+
33+
**Patch**
34+
35+
```
36+
fix(release): manually release a patch version
37+
38+
There was an issue with a patch release, so this manual-releases.md
39+
change is to release a new patch version.
40+
41+
Reference: #<the number of a relevant pull request, issue, or commit>
42+
```
43+
44+
The number of times we've had to do a manual release is: 1

0 commit comments

Comments
 (0)