autorel 2.2.6 → 2.2.7
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 +5 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -35,6 +35,8 @@ _Currently only has built-in support for `GitHub` and `NPM`, but you can write y
|
|
|
35
35
|
- Comprehensive test coverage
|
|
36
36
|
- Less broken builds and more time to focus on your code!
|
|
37
37
|
|
|
38
|
+
[Read our FAQ on why you should use `autorel` and how it compares to other tools](docs/faq.md)
|
|
39
|
+
|
|
38
40
|
# Table of Contents
|
|
39
41
|
|
|
40
42
|
- [Example Usage (CLI)](#example-usage-cli)
|
|
@@ -74,7 +76,9 @@ autorel --publish
|
|
|
74
76
|
|
|
75
77
|
## Avoiding Breaking Changes
|
|
76
78
|
|
|
77
|
-
|
|
79
|
+
If using the `npx` command, you may want to append the version number to prevent breaking changes in the future. You can do this by appending `@^` followed by the major version number.
|
|
80
|
+
|
|
81
|
+
Example: `npx autorel@^2`
|
|
78
82
|
|
|
79
83
|
# Example Usage (Library)
|
|
80
84
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "autorel",
|
|
3
|
-
"version": "2.2.
|
|
3
|
+
"version": "2.2.7",
|
|
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)",
|