@@ -12,9 +12,9 @@ In order for the automation to work properly, contributors must follow the
12
12
1 . Pull requests are automatically labelled by branch name. Labels are then used
13
13
for:
14
14
15
- 1 . resolving next [ semantic version number] [ semver ]
16
- (BREAKING.FEATURE.PATCH),
17
- 2 . grouping changes in changelog.
15
+ 1 . resolving next [ semantic version number] [ semver ]
16
+ (BREAKING.FEATURE.PATCH),
17
+ 2 . grouping changes in changelog.
18
18
19
19
2 . Release draft with changelog is generated as pull requests are merged into
20
20
the ` master ` branch. Invididual PR names are listed and grouped by type based
@@ -30,35 +30,36 @@ See the source of `.github/workflows` for details.
30
30
[ GitHub releases page] [ gh-releases ] to see what the changelog looks like and
31
31
what will be the next version number.
32
32
33
- ** Don't edit manually until you are ready to publish the release.** Release
34
- draft is automatically overwritten everytime a change is merged to ` master ` .
33
+ ** Don't edit manually until you are ready to publish the release.** Release
34
+ draft is automatically overwritten everytime a change is merged to ` master ` .
35
35
36
36
2 . ** Manual:** once you are ready to publish a release:
37
37
38
- 1 . ** Bump the version number** in ` package.json ` and ` package-lock.json ` .
39
- Make sure it matches the intended version number in the release draft.
40
- ** Don't combine this step with any other changes,** they wouldn't be
41
- reflected in the changelog.
38
+ 1 . ** Bump the version number** in ` package.json ` and ` package-lock.json ` .
39
+ Make sure it matches the intended version number in the release draft.
40
+ ** Don't combine this step with any other changes,** they wouldn't be
41
+ reflected in the changelog.
42
42
43
- 2 . Now is also your ** chance to review and adjust (if necessary) the intended
44
- version and actual changelog before the release is published.**
45
- Automatic release drafting is skipped when a version change in
46
- ` package.json ` is detected so this time your changes will not be
47
- overwritten. Save your changes in release draft with the _ Save draft_
48
- button, ** do not publish** yet!
43
+ 2 . Now is also your ** chance to review and adjust (if necessary) the
44
+ intended
45
+ version and actual changelog before the release is published.**
46
+ Automatic release drafting is skipped when a version change in
47
+ ` package.json ` is detected so this time your changes will not be
48
+ overwritten. Save your changes in release draft with the _ Save draft_
49
+ button, ** do not publish** yet!
49
50
50
- 3 . Get back to the repository, commit both files as
51
- ` Bump version to <VERSION_NUMBER> ` in ` release/<VERSION_NUMBER> ` branch,
52
- create a pull request, hold your breath, and—merge it.
51
+ 3 . Get back to the repository, commit both files as
52
+ ` Bump version to <VERSION_NUMBER> ` in ` release/<VERSION_NUMBER> ` branch,
53
+ create a pull request, hold your breath, and—merge it.
53
54
54
55
3 . ** Automatic:** once the release pull request from step 2.3 is merged, the
55
56
following actions are triggered automatically:
56
57
57
- 1 . GitHub release draft with name corresponding to the version number from
58
- step 2 is published.
59
- 2 . Git tag with the version number from step 2 is added to ` master ` branch.
60
- 3 . Package is built and published to npm package registry.
61
- 4 . Documentation is built and deployed to production.
58
+ 1 . GitHub release draft with name corresponding to the version number from
59
+ step 2 is published.
60
+ 2 . Git tag with the version number from step 2 is added to ` master ` branch.
61
+ 3 . Package is built and published to npm package registry.
62
+ 4 . Documentation is built and deployed to production.
62
63
63
64
** Note:** prefix version number with ` v ` everywhere except in ` package.json ` and
64
65
` package-lock.json ` .
0 commit comments