autorel 1.1.0 → 1.1.2
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 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -34,14 +34,13 @@ Autorel automatically does the following, if appropriate:
|
|
|
34
34
|
|
|
35
35
|
- [Example Usage (CLI)](#example-usage-cli)
|
|
36
36
|
- [Example Usage (Library)](#example-usage-library)
|
|
37
|
-
- [Quick Start](#quick-start)
|
|
38
37
|
- [Usage with GitHub Actions](#usage-with-github-actions)
|
|
39
38
|
- [Example Commit Messages](#example-commit-messages)
|
|
40
39
|
- [Configuration](#configuration)
|
|
41
40
|
- [Sample YAML Configuration](#sample-yaml-configuration)
|
|
42
41
|
- [Types](#types)
|
|
43
42
|
- [Debug Mode](#debug-mode)
|
|
44
|
-
- [FAQ](docs/
|
|
43
|
+
- [FAQ](docs/faq.md)
|
|
45
44
|
- [Support, Feedback, and Contributions](#support-feedback-and-contributions)
|
|
46
45
|
|
|
47
46
|
# Example Usage (CLI)
|
|
@@ -83,28 +82,7 @@ autorel --publish
|
|
|
83
82
|
|
|
84
83
|
console.log(`Next version is ${nextVersion}`);
|
|
85
84
|
```
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
There are many ways to use `autorel`. Here are a few common scenarios:
|
|
89
|
-
|
|
90
|
-
1. **CLI**: Run `autorel` directly from the command line
|
|
91
|
-
2. **Library**: Import `autorel` into your project and use it as a library
|
|
92
|
-
3. **CI/CD pipeline**: Use `autorel` with GitHub Actions, CircleCI, Jenkins, etc. to automate your releases
|
|
93
|
-
|
|
94
|
-
You can also use `autorel` with other languages, not just Node.js. Just make sure you have Node.js installed on the system.
|
|
95
|
-
|
|
96
|
-
If you want to use GitHub Actions to automate your releases, [see here](#usage-with-github-actions) for setup and sample configuration.
|
|
97
|
-
|
|
98
|
-
It's also recommended you create a `.autorel.yaml` file in the root of your project to [configure](#configuration) `autorel`. Example:
|
|
99
|
-
|
|
100
|
-
```yaml
|
|
101
|
-
branches:
|
|
102
|
-
- {name: 'main'}
|
|
103
|
-
- {name: 'alpha', channel: 'alpha'}
|
|
104
|
-
- {name: 'beta', channel: 'beta'}
|
|
105
|
-
publish: true
|
|
106
|
-
```
|
|
107
|
-
|
|
85
|
+
|
|
108
86
|
# Usage with GitHub Actions
|
|
109
87
|
|
|
110
88
|
You can use `autorel` with GitHub Actions to automate your releases (recommended).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "autorel",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.2",
|
|
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)",
|