autorel 2.5.11 → 2.5.12
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 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -78,15 +78,17 @@ See [Usage](/docs/usage.md) and [Configuration Options](/docs/configuration-opti
|
|
|
78
78
|
|
|
79
79
|
## Commit Messages
|
|
80
80
|
|
|
81
|
-
Commit messages are parsed to determine the version bump
|
|
81
|
+
Commit messages are parsed to automatically determine the version bump and generate the changelog.
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
They must follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard specification.
|
|
84
|
+
|
|
85
|
+
Here are some examples of commit messages and the resulting version bump (with the default configuration):
|
|
84
86
|
|
|
85
87
|
- `fix: fix a bug` -> `0.0.1` (patch)
|
|
86
88
|
- `feat: add new feature` -> `0.1.0` (minor)
|
|
87
89
|
- `feat!: add breaking change` -> `1.0.0` (major)
|
|
88
90
|
|
|
89
|
-
See our [default configuration](/src/defaults.ts) for more details on how commit types are mapped to version bumps.
|
|
91
|
+
See our [default configuration](/src/defaults.ts) for more details on how commit types are mapped to version bumps and the changelog.
|
|
90
92
|
|
|
91
93
|
You can find more examples in the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) documentation.
|
|
92
94
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "autorel",
|
|
3
|
-
"version": "2.5.
|
|
3
|
+
"version": "2.5.12",
|
|
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)",
|