autorel 0.0.30 → 0.0.31
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 +27 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ Autorel automatically does the following, if appropriate:
|
|
|
20
20
|
- Runs any arbitrary command or bash script after the release is complete
|
|
21
21
|
|
|
22
22
|
**✅ Conventional Commit and SemVer Compliant**
|
|
23
|
-
|
|
23
|
+
- 100% compliant with Conventional Commits and SemVer out of the box, including "!" for breaking changes
|
|
24
24
|
|
|
25
25
|
**😃 Simple & Easy to Use**
|
|
26
26
|
- No confusing configuration files or complex setup
|
|
@@ -32,14 +32,20 @@ Autorel automatically does the following, if appropriate:
|
|
|
32
32
|
- If using CLI, supports both `yaml` configuration and arguments
|
|
33
33
|
- Highly customizable without being overly complex
|
|
34
34
|
|
|
35
|
+
**🚀 Fast & Lightweight**
|
|
36
|
+
|
|
37
|
+
- Minimal dependencies and fast execution
|
|
38
|
+
|
|
35
39
|
# Table of Contents
|
|
36
40
|
|
|
37
41
|
- [Example Usage (CLI)](#example-usage-cli)
|
|
38
42
|
- [Example Usage (Library)](#example-usage-library)
|
|
39
43
|
- [Usage with GitHub Actions](#usage-with-github-actions)
|
|
44
|
+
- [Example Commit Messages](#example-commit-messages)
|
|
40
45
|
- [Configuration](#configuration)
|
|
41
46
|
- [Sample YAML Configuration](#sample-yaml-configuration)
|
|
42
47
|
- [Types](#types)
|
|
48
|
+
- [Debug Mode](#debug-mode)
|
|
43
49
|
- [Support, Feedback, and Contributions](#support-feedback-and-contributions)
|
|
44
50
|
|
|
45
51
|
# Example Usage (CLI)
|
|
@@ -125,6 +131,16 @@ jobs:
|
|
|
125
131
|
run: npx autorel --publish
|
|
126
132
|
```
|
|
127
133
|
|
|
134
|
+
# Example Commit Messages
|
|
135
|
+
|
|
136
|
+
Here are some examples of commit messages and the resulting version bump (default configuration):
|
|
137
|
+
|
|
138
|
+
- `fix: fix a bug` -> `0.0.1`
|
|
139
|
+
- `feat: add new feature` -> `0.1.0`
|
|
140
|
+
- `feat!: add breaking change` -> `1.0.0`
|
|
141
|
+
|
|
142
|
+
You can find more examples in the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) documentation.
|
|
143
|
+
|
|
128
144
|
# Configuration
|
|
129
145
|
|
|
130
146
|
When run in CLI mode, `autorel` can be configured via CLI arguments or a `yaml` file. CLI arguments take precedence over the `yaml` file.
|
|
@@ -259,6 +275,16 @@ run: echo 'Hello, World!'
|
|
|
259
275
|
|
|
260
276
|
You can find the types defined at [src/index.ts](src/index.ts).
|
|
261
277
|
|
|
278
|
+
# Debug Mode
|
|
279
|
+
|
|
280
|
+
To enable debug mode, set `AUTOREL_DEBUG=1`:
|
|
281
|
+
|
|
282
|
+
```bash
|
|
283
|
+
AUTOREL_DEBUG=1 npx autorel
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
This will output configuration and other debug information.
|
|
287
|
+
|
|
262
288
|
# Support, Feedback, and Contributions
|
|
263
289
|
|
|
264
290
|
- Star this repo if you like it!
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "autorel",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.31",
|
|
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)",
|