autorel 0.0.31 → 0.0.33
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 +6 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -27,14 +27,9 @@ Autorel automatically does the following, if appropriate:
|
|
|
27
27
|
- Works with any CI/CD system, including GitHub Actions
|
|
28
28
|
- Built-in TypeScript and bash script support
|
|
29
29
|
|
|
30
|
-
**💪 Flexible & Powerful**
|
|
31
|
-
- Use via `npx`, or import as a library
|
|
32
|
-
- If using CLI, supports both `yaml` configuration and arguments
|
|
33
|
-
- Highly customizable without being overly complex
|
|
34
|
-
|
|
35
30
|
**🚀 Fast & Lightweight**
|
|
36
|
-
|
|
37
31
|
- Minimal dependencies and fast execution
|
|
32
|
+
- Less broken builds and more time to focus on your code!
|
|
38
33
|
|
|
39
34
|
# Table of Contents
|
|
40
35
|
|
|
@@ -61,7 +56,7 @@ This will:
|
|
|
61
56
|
3. Publish the release to NPM
|
|
62
57
|
4. Run the command `echo "Next version is ${NEXT_VERSION}"`
|
|
63
58
|
|
|
64
|
-
You can also install `autorel` globally and run it
|
|
59
|
+
You can also install `autorel` globally and run it directly:
|
|
65
60
|
|
|
66
61
|
```bash
|
|
67
62
|
npm i -g autorel
|
|
@@ -145,7 +140,7 @@ You can find more examples in the [Conventional Commits](https://www.conventiona
|
|
|
145
140
|
|
|
146
141
|
When run in CLI mode, `autorel` can be configured via CLI arguments or a `yaml` file. CLI arguments take precedence over the `yaml` file.
|
|
147
142
|
|
|
148
|
-
When used as a library, you can pass the configuration directly to the `autorel` function.
|
|
143
|
+
When used as a library, you can pass the configuration directly to the `autorel` function.
|
|
149
144
|
|
|
150
145
|
All arguments are optional, but setting `branches` is recommended.
|
|
151
146
|
|
|
@@ -181,8 +176,8 @@ A command to run after the release is complete. The following environment variab
|
|
|
181
176
|
|
|
182
177
|
| Variable | Description |
|
|
183
178
|
| --- | --- |
|
|
184
|
-
| `NEXT_VERSION` | The
|
|
185
|
-
| `NEXT_TAG` | The
|
|
179
|
+
| `NEXT_VERSION` | The new version number (without the `v`) |
|
|
180
|
+
| `NEXT_TAG` | The new tag, ie. v3.1.0 |
|
|
186
181
|
|
|
187
182
|
- CLI: `--run`
|
|
188
183
|
- Argument: `run: string`
|
|
@@ -190,7 +185,7 @@ A command to run after the release is complete. The following environment variab
|
|
|
190
185
|
|
|
191
186
|
## runScript (YAML only)
|
|
192
187
|
|
|
193
|
-
A bash script to run after the release is complete.
|
|
188
|
+
A bash script to run after the release is complete. The same environment variables are available as above.
|
|
194
189
|
|
|
195
190
|
> ❗️ This requires `bash` to be installed on the system.
|
|
196
191
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "autorel",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.33",
|
|
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)",
|