@omnitoolkit/releasebot 7.3.1 → 7.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
This program analyzes a git repository and, if necessary, performs a release according to the specifications of [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) and [semantic versioning](https://semver.org/spec/v2.0.0.html).
|
|
4
4
|
|
|
5
|
-
It uses [semantic-release](https://github.com/semantic-release/semantic-release) (see [documentation](https://semantic-release.gitbook.io/semantic-release))
|
|
5
|
+
It uses [semantic-release](https://github.com/semantic-release/semantic-release) (see [documentation](https://semantic-release.gitbook.io/semantic-release)) as an npm CLI package with a custom-made module (see [index.js](src/index.js)). There, several plugins along with their configuration are defined and loaded on execution:
|
|
6
6
|
|
|
7
7
|
- [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer) reads each git commit added since the last release, determines if a new release is due, the type of release and the new version number. It analyzes the syntax according to the conventionalcommits preset in [parser.js](https://github.com/conventional-changelog/conventional-changelog/blob/conventional-changelog-conventionalcommits-v9.0.0/packages/conventional-changelog-conventionalcommits/src/parser.js) and checks for custom rules combined from the [default rules list](https://github.com/semantic-release/commit-analyzer/blob/v13.0.1/lib/default-release-rules.js) and the [@commitlint/config-conventional type list](https://github.com/conventional-changelog/commitlint/blob/v19.8.1/%40commitlint/config-conventional/README.md#type-enum). A commit should look like this:
|
|
8
8
|
```
|
|
@@ -43,15 +43,15 @@ It uses [semantic-release](https://github.com/semantic-release/semantic-release)
|
|
|
43
43
|
- deploy
|
|
44
44
|
- release
|
|
45
45
|
```
|
|
46
|
-
- Then add the following job and replace
|
|
46
|
+
- Then add the following job and replace the package version with the desired version from the [releases](https://gitlab.com/omnitoolkit/omnitoolkit/-/releases) page:
|
|
47
47
|
```yaml
|
|
48
48
|
release_version:
|
|
49
|
-
image:
|
|
49
|
+
image: docker.io/library/node:24.15.0
|
|
50
50
|
stage: release
|
|
51
51
|
rules:
|
|
52
52
|
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
|
|
53
53
|
script:
|
|
54
|
-
- releasebot --branches ${CI_DEFAULT_BRANCH}
|
|
54
|
+
- npx --yes @omnitoolkit/releasebot@7.4.0 --branches ${CI_DEFAULT_BRANCH}
|
|
55
55
|
```
|
|
56
56
|
- If `CI_DEFAULT_BRANCH` is not your release branch, replace it with the correct one.
|
|
57
57
|
- If you don't want to release on every push to the release branch, add `when: manual` to the job. You can now start the job on demand from the UI.
|
package/package.json
CHANGED