You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/RELEASE.md
+14-6
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,12 @@
1
1
## Releasing a version
2
2
3
-
Releasing a version is mostly automated. However since the CHANGELOG.md + version information are part of the git history and need to be committed, some manual steps are still needed. These steps are also there to check for errors which may have been made in the git history via the [Conventionalcommits standard](https://www.conventionalcommits.org/en/v1.0.0/) format.
3
+
Releasing a version is mostly automated. However since the CHANGELOG.md + version information are part of the git
4
+
history and need to be committed, some manual steps are still needed. These steps are also there to check for errors
5
+
which may have been made in the git history via
6
+
the [Conventionalcommits standard](https://www.conventionalcommits.org/en/v1.0.0/) format.
4
7
5
-
The NPM package [Commit-And-Tag](https://github.com/absolute-version/commit-and-tag-version) is used to streamline the release process.
8
+
The NPM package [Commit-And-Tag](https://github.com/absolute-version/commit-and-tag-version) is used to streamline the
9
+
release process.
6
10
7
11
### Preparing a release
8
12
@@ -17,12 +21,16 @@ The following convenience NPM scripts are available for use here:
17
21
}
18
22
```
19
23
20
-
1) Execute `npm run commit-release` to prepare the release. This will automatically bump the version to the next correct semantic version, create a CHANGELOG.md file and make a commit.
24
+
1) Execute `npm run commit-release` to prepare the release. This will automatically bump the version to the next correct
25
+
semantic version, create a CHANGELOG.md file and make a commit.
21
26
2) Check the CHANGELOG.md for wrong entries which may have been committed in the history - We are human after all! :)
22
-
3) Push the commit, create a PR and wait for the merge.
27
+
3) Push the commit, create a PR and wait for the merge.
23
28
24
29
### Deploying a release
25
30
26
31
1) Execute `npm run tag-release` on the main branch after the above merge.
27
-
2) Push the tag via 'git push --follow-tags origin feature-x'. The command should be shown in the terminal after step 1. A push of a release tag with the correct format will automatically trigger an official release GitHub workflow.
28
-
3) Check if the GitHub package was uploaded successfully.
32
+
2) Push the tag via 'git push origin feature-x'. "Origin" may differ if working with forks. The command should be shown
33
+
in the terminal after step 1. A push of a release tag with the correct format will automatically trigger an official
34
+
release GitHub workflow.
35
+
3) Check if the artifacts were uploaded successfully to the Nexus repository.
36
+
4) Close the uploaded staging repository and check the activity tab if all steps were successful.
0 commit comments