Exec Plugin
Tap into hooks and run commands on the terminal.
Main hooks, in call order:
- beforeRun
- getRepository
- getAuthor
- beforeShipIt
- getPreviousVersion
- afterAddToChangelog
- beforeCommitChangelog
- version
- afterVersion
- publish
- afterPublish
- afterRelease
- afterShipIt
Other hooks:
- canary
- next
- modifyConfig
- makeRelease
- onCreateLogParse
- parseCommit
- omitCommit
- onCreateChangelog
- renderChangelogLine
- renderChangelogTitle
- renderChangelogAuthor
- renderChangelogAuthorLine
- omitReleaseNotes
- onCreateRelease
- createChangelogTitle
Installation
This plugin is not included with the auto
CLI installed via NPM. To install:
npm i --save-dev @auto-it/exec
# or
yarn add -D @auto-it/exec
Usage
Here is an example of replacing the npm
plugins with a light-weight version.
All args to a hook are exposed on the process in environment variables.
The format looks like $ARG_0
, $ARG_1
, and so on.
Please look at the docs for writing plugins for more detail on what's available.
{
"plugins": [
[
"exec",
{
"version": "npm version $ARG_0",
"publish": "npm publish && git push --tags",
"afterRelease": "yarn docs && push-dir --dir=docs --branch=gh-pages"
}
]
// other plugins
]
}
::: message is-warning