File tree 1 file changed +45
-0
lines changed
1 file changed +45
-0
lines changed Original file line number Diff line number Diff line change
1
+ Here is a guide for how to make sure that changelog and releases work properly:
2
+
3
+ # Commit Messages
4
+
5
+ The following are example commit messages which conform to the proper format
6
+
7
+ ## For bug-fixes
8
+
9
+ ** fix: Fixed issue with XYZ (fixes #100 )**
10
+
11
+ (The fix: prefix means a bug fix has applied, so the patch version will be bumped — ie. 1.0.1 > 1.0.2)
12
+
13
+ ## For new features
14
+
15
+ ** feat: Added feature A**
16
+
17
+ (The feat: prefix means a feature has been added, so the minor version will be bumped — ie. 1.0.1 > 1.1.0)
18
+
19
+ ## For breaking changes
20
+
21
+ ** feat!: Added feature B**
22
+
23
+ (The exclamation mark says it's a breaking change, and the major version will be bumped — ie. 1.0.1 > 2.0.0)
24
+
25
+ # Merging PRs
26
+
27
+ Make sure to merge PRs as a squash and ensure the commit message conforms to the above format
28
+
29
+ # Release
30
+
31
+ When you're ready to run a release, run
32
+ ``` sh
33
+ standard-version
34
+ ```
35
+
36
+ This will do the following:
37
+
38
+ - Update changelog
39
+ - Bump the version #
40
+ - Create a commit with the version #
41
+ - Create a tag with the version # on the new commit
42
+
43
+ When this is done, quickly make sure that the changelog looks correct, then you can push the commit and tags
44
+
45
+ After this, the GH action will automatically publish and generate the GH release
You can’t perform that action at this time.
0 commit comments