autorel 2.0.2 → 2.0.3

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.
Files changed (2) hide show
  1. package/README.md +9 -5
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -125,10 +125,10 @@ jobs:
125
125
  - run: npm ci
126
126
  - run: npm run lint
127
127
  - run: npm run test
128
- - env:
129
- GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
130
- NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
131
- run: npx autorel --publish
128
+ - run: npx autorel --publish
129
+ env:
130
+ GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
131
+ NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
132
132
  ```
133
133
 
134
134
  It's also recommended you create a `.autorel.yaml` file in the root of your project to [configure](#configuration) `autorel`.
@@ -149,7 +149,9 @@ You can find more examples in the [Conventional Commits](https://www.conventiona
149
149
 
150
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.
151
151
 
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).
152
+ Simply use the `--skip-release` flag (arg: `skipRelease: 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
+ If you're interested in contributing built-in support for other systems, please open an issue or PR.
153
155
 
154
156
  # Usage with Other Languages (not Node.js)
155
157
 
@@ -157,6 +159,8 @@ Simply use the `--no-release` flag (arg: `noRelease: true`) to skip creating a r
157
159
 
158
160
  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).
159
161
 
162
+ If you're interested in contributing built-in support for other systems, please open an issue or PR.
163
+
160
164
  # Configuration
161
165
 
162
166
  When run in CLI mode, `autorel` can be configured via CLI arguments or a `yaml` file. CLI arguments take precedence over the `yaml` file.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "autorel",
3
- "version": "2.0.2",
3
+ "version": "2.0.3",
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)",