autorel 0.0.17 → 0.0.19
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 +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -73,13 +73,13 @@ This will do the same as the CLI example above.
|
|
|
73
73
|
|
|
74
74
|
# Configuration
|
|
75
75
|
|
|
76
|
-
|
|
76
|
+
When run in CLI mode, `autorel` can be configured via CLI arguments or a `yaml` file. CLI arguments take precedence over the `yaml` file.
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
When used as a library, you can pass the configuration directly to the `autorel` function. [See below](#types) for the types of configuration options.
|
|
79
79
|
|
|
80
80
|
All arguments are optional, but setting `branches` is recommended.
|
|
81
81
|
|
|
82
|
-
>
|
|
82
|
+
> ❗️ The `yaml` configuration file must be named `.autorel.yml` and be in the root of your project.
|
|
83
83
|
|
|
84
84
|
## help (CLI only)
|
|
85
85
|
|
|
@@ -138,7 +138,7 @@ runScript: |
|
|
|
138
138
|
|
|
139
139
|
## tag
|
|
140
140
|
|
|
141
|
-
The tag to use for the release.
|
|
141
|
+
The tag to use for the release. This will be used verbatim, instead of being generated from the version number. Always results in a release being created unless `noRelease` is `true`. **Advanced usage only.**
|
|
142
142
|
|
|
143
143
|
- CLI: `--tag`
|
|
144
144
|
- Argument: `tag: string`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "autorel",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.19",
|
|
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)",
|