autorel 1.1.4 → 1.1.5
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 +10 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -39,7 +39,8 @@ _Currently only comes with built-in support for `GitHub` and `NPM`, but you can
|
|
|
39
39
|
- [Example Usage (Library)](#example-usage-library)
|
|
40
40
|
- [Usage with GitHub Actions](#usage-with-github-actions)
|
|
41
41
|
- [Example Commit Messages](#example-commit-messages)
|
|
42
|
-
- [Usage with
|
|
42
|
+
- [Usage with Other Repositories (not GitHub)](#usage-with-other-repositories-not-github)
|
|
43
|
+
- [Usage with Other Languages (not Node.js)](#usage-with-other-languages-not-nodejs)
|
|
43
44
|
- [Configuration](#configuration)
|
|
44
45
|
- [Sample YAML Configuration](#sample-yaml-configuration)
|
|
45
46
|
- [Types](#types)
|
|
@@ -144,11 +145,17 @@ Here are some examples of commit messages and the resulting version bump (defaul
|
|
|
144
145
|
|
|
145
146
|
You can find more examples in the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) documentation.
|
|
146
147
|
|
|
147
|
-
# Usage with
|
|
148
|
+
# Usage with Other Repositories (not GitHub)
|
|
148
149
|
|
|
149
150
|
`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.
|
|
150
151
|
|
|
151
|
-
Simply use the `--no-release` flag (arg: `noRelease:
|
|
152
|
+
Simply use the `--no-release` flag (arg: `noRelease: true`) to skip creating a release on GitHub. Then, you can use either the `--run` flag (arg: `run: string`) or `runScript` arg to run any command or script after the version bump with the new version number available as an environment variable [see below](#run).
|
|
153
|
+
|
|
154
|
+
# Usage with Other Languages (not Node.js)
|
|
155
|
+
|
|
156
|
+
`autorel` is designed to work with any language or platform. You can use it with Python, Ruby, Go, Java, or any other language.
|
|
157
|
+
|
|
158
|
+
Simply omit the `--publish` flag (arg: `publish: false`, which is default) to skip publishing to NPM. Then, you can use either the `--run` flag (arg: `run: string`) or `runScript: string` arg to run any command or script after the version bump with the new version number available as an environment variable [see below](#run).
|
|
152
159
|
|
|
153
160
|
# Configuration
|
|
154
161
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "autorel",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.5",
|
|
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)",
|