autorel 2.5.5 → 2.5.7
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 +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ It follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/
|
|
|
11
11
|
|
|
12
12
|
- Run pre-release tasks (tests, builds, etc.)
|
|
13
13
|
- Bump the version and tag based on commit messages
|
|
14
|
-
- Create tagged GitHub releases with notes
|
|
14
|
+
- Create tagged GitHub releases with changelog notes
|
|
15
15
|
- Publish to npm registry (or other package managers)
|
|
16
16
|
- Run custom scripts or commands with the new version number available as an environment variable
|
|
17
17
|
|
|
@@ -131,7 +131,7 @@ If you need access to the new version number in your CI/CD pipeline, you can use
|
|
|
131
131
|
|
|
132
132
|
## Usage with Other Repositories (not GitHub)
|
|
133
133
|
|
|
134
|
-
`autorel` is designed to work with any CI/CD system, not just GitHub Actions. You can use it with GitLab, Bitbucket, Jenkins, or any other system that supports running shell commands.
|
|
134
|
+
`autorel` is designed to work with any CI/CD system, not just GitHub Actions. You can use it with GitLab, Bitbucket, Jenkins, or any other system that supports running shell commands and meets our [system requirements](#system-requirements).
|
|
135
135
|
|
|
136
136
|
Simply use the `--skip-release` flag (arg: `skipRelease: true`) to skip creating a release on GitHub. Then, you can use the `--run` flag (arg: `run: string`) to run any command or script after the version bump with the new version number available as an environment variable [see below](#run).
|
|
137
137
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "autorel",
|
|
3
|
-
"version": "2.5.
|
|
3
|
+
"version": "2.5.7",
|
|
4
4
|
"description": "Automate semantic releases based on conventional commits. Similar to semantic-release but much simpler.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Marc H. Weiner <mhweiner234@gmail.com> (https://mhweiner.com)",
|