@alleyinteractive/create-release
Advanced tools
Comparing version 0.1.0 to 0.1.2
@@ -6,3 +6,3 @@ { | ||
"name": "@alleyinteractive/create-release", | ||
"version": "0.1.0", | ||
"version": "0.1.2", | ||
"devDependencies": { | ||
@@ -9,0 +9,0 @@ "@alleyinteractive/eslint-config": "*", |
@@ -5,1 +5,46 @@ # Create Release | ||
[Create WordPress Plugin](https://github.com/alleyinteractive/create-wordpress-plugin) plugin. | ||
When run, it will trigger a new version to be set in the plugin's | ||
`composer.json` and plugin's header. This sets up the [GitHub Action | ||
workflow](https://github.com/alleyinteractive/create-wordpress-plugin/blob/HEAD/.github/workflows/built-release.yml) | ||
which listens for a new version to automatically build and publish to Git. | ||
Running this package's command is optional and can be done manually by the user. | ||
## Usage | ||
Run the package with npx: | ||
```sh | ||
npx @alleyinteractive/release@latest | ||
``` | ||
The command will prompt the user for a release type and version number. The | ||
following arguments are available: | ||
``` | ||
-v, --version string The version number to set for the release. | ||
--major Bump the major version number. | ||
--minor Bump the minor version number. | ||
--patch Bump the patch version number. | ||
-p, --path string The path to the plugin. Supports relative and absolute paths. | ||
--dry-run Run the command without making any changes. | ||
-h, --help Prints help information. | ||
``` | ||
If the command is not run from the root of a plugin, you can either pass the | ||
`--path` argument or the command will prompt you for the path to the plugin to | ||
release. | ||
## Changelog | ||
This project keeps a [changelog](CHANGELOG.md). | ||
## Contributors | ||
Thanks to all of the [contributors](../../CONTRIBUTORS.md) to this project. | ||
## License | ||
This project is licensed under the | ||
[GNU Public License (GPL) version 2](LICENSE) or later. |
Copyleft License
License(Experimental) Copyleft license information was found
Found 1 instance in 1 package
SPDX disjunction
LicenseSPDX disjunction for an artifact's license information
Found 1 instance in 1 package
Mixed license
License(Experimental) Package contains multiple licenses.
Found 1 instance in 1 package
Non-permissive License
License(Experimental) A license not known to be considered permissive was found
Found 1 instance in 1 package
Copyleft License
License(Experimental) Copyleft license information was found
Found 1 instance in 1 package
SPDX disjunction
LicenseSPDX disjunction for an artifact's license information
Found 1 instance in 1 package
Non-permissive License
License(Experimental) A license not known to be considered permissive was found
Found 1 instance in 1 package
54340
23
50
4