1.0.1 • Published 3 years ago
webthings-addon-cli v1.0.1
WebThings addon CLI
This CLI helps you to prepare a new release of your addon and publish it by adding it to the addon-list repo.
Commands
Config
The addon works without any configuration.
If you need to override some defaults, you can use this command.
| Setting | Purpose |
|---|---|
| githubUser | The GitHub user under which you have forked the addon-list repo |
| userName | The git user.name for new commits |
| userEmail | The git user.email for new commits |
The config is saved under ~/.webthings-addon-cli/config.json.
Prepare update <patch, minor, major>
This command creates a new tagged release commit using the following steps:
- Patch the versions in the
manifest.json,package.json(node addons only), andpackage-lock.json(node addons only) files. The version will be increased according to the semantic versioning level you passed in as an argument. - Collect all commit messages since the last tag.
- Create a new release commit with the collected commit messages.
- Tag the release commit with the new version.
After you executed the command, you need to push the new release with git push --tags.
Release update
After the CI pipeline built the new packages, you can use this command to prepare a PR in the addon-list repo.
The command does the following steps for you:
- Fetch the checksum files for the new release from your GitHub repo.
- Create an updated addons file
- Clone the addon-list repo
- Create a new update branch with the new addons file
- Push the new branch to your fork of the addon-list repo
All you need to do now is to create a new PR based on the pushed branch.