auto-release-cli
Advanced tools
CLI tools to help facilitate semantic versioning based on Github PR labels.
Generate releases based on semantic version labels on pull requests.
CI/CD helpers for github releases. Generate releases based on semantic version labels on pull requests.
Release Features:
no-release labelPull Request Interaction Features:
The following tools help facilitate automated publishing.
Here is an example release release script:
export PATH=$(npm bin):$PATH
VERSION=`auto version`
## Support for label 'no-release'
if [ ! -z "$VERSION" ]; then
auto changelog
npm version $VERSION -m "Bump version to: %s [skip ci]"
npm publish
git push --follow-tags --set-upstream origin $branch
auto release
fi
or for lerna
export PATH=$(npm bin):$PATH
VERSION=`auto version`
if [ ! -z "$VERSION" ]; then
auto changelog
lerna publish --yes --force-publish=* $VERSION -m '%v [skip ci]'
auto release
fi
or you could just use scripts
{
"scripts": {
"release": "if [ ! -z `auto version` ]; then npm run publish; fi",
"prepublish": "auto changelog",
"publish": "npm version `auto version` -m \"Bump version to: %s [skip ci]\" && npm publish",
"postpublish": "git push --follow-tags --set-upstream origin $branch && auto release"
}
}
auto versionGet the semantic version bump for the given changes. Requires all PRs to have labels for the change type.
> auto version -h
usage: auto version.js [-h] [--onlyPublishWithReleaseLabel] [--major MAJOR]
[--minor MINOR] [--patch PATCH] [-v] [-vv]
[--githubApi GITHUBAPI]
Optional arguments:
-h, --help Show this help message and exit.
--onlyPublishWithReleaseLabel
Only bump version if `release` label is on pull
request
--major MAJOR The name of the tag for a major version bump
--minor MINOR The name of the tag for a minor version bump
--patch PATCH The name of the tag for a patch version bump
-v, --verbose Show some more logs
-vv, --very-verbose Show a lot more logs
--githubApi GITHUBAPI
Github API to use
Useful in conjunction with npm version to auto-version releases.
To create a prerelease add the prerelease label to your pull request.
To not create a release for a pull request add the no-release label. Any pull request with this tag will make auto version return ''.
NOTE: You must check the return value of auto version in a bash script like in the example above for the no-release label to function properly.
To override the label text used for versioning define new labels in the .autorc.
{
"labels": {
"major": "Version: Major",
"minor": "Version: Minor",
"patch": "Version: Patch",
"no-release": "NO!",
"release": "Autobots, rollout!",
"prerelease": "beta"
}
}
auto changelogPrepend release notes to CHANGELOG.md, create one if it doesn't exist, and commit the changes.
NOTE: This should be run before npm version so the CHANGELOG.md changes are committed before the release gets tagged.
> auto changelog -h
usage: auto changelog.js [-h] [--from FROM] [--to TO] [--jira JIRA]
[--no-version-prefix] [-d] [-m MESSAGE] [-v] [-vv]
[--githubApi GITHUBAPI]
Optional arguments:
-h, --help Show this help message and exit.
--from FROM Tag to start changelog generation on. Defaults to
latest tag.
--to TO Tag to end changelog generation on. Defaults to HEAD.
--jira JIRA Jira base URL
--no-version-prefix Use the version as the tag without the `v` prefix
-d, --dry-run Don't actually commit status. Just print the request
body
-m MESSAGE, --message MESSAGE
Message to commit the changelog with. Defaults to
"Update CHANGELOG.md [skip ci]"
-v, --verbose Show some more logs
-vv, --very-verbose Show a lot more logs
--githubApi GITHUBAPI
Github API to use
To include Jira story information you must include a URL to your hosted JIRA instance as a CLI or .autorc config option.
auto releaseAuto-generate a github release.
# package.json
{
"postpublish": "auto release"
}
Make sure the branch/tag you're releasing is on github before running auto release.
You may need to push the tags to github first:
# package.json
{
"postpublish": "git push --follow-tags --set-upstream origin $branch && auto release"
}
> auto release -h
usage: auto release.js [-h] [-s SLACK] [--use-version USE_VERSION]
[--jira JIRA] [--no-version-prefix] [-d] [-v] [-vv]
[--githubApi GITHUBAPI]
Optional arguments:
-h, --help Show this help message and exit.
-s SLACK, --slack SLACK
Post a message to slack about the release. Make sure
the SLACK_TOKEN environment variable is set.
--use-version USE_VERSION
Version number to publish as. Defaults to reading
from the package.json.
--jira JIRA Jira base URL
--no-version-prefix Use the version as the tag without the `v` prefix
-d, --dry-run Don't actually commit status. Just print the request
body
-v, --verbose Show some more logs
-vv, --very-verbose Show a lot more logs
--githubApi GITHUBAPI
Github API to use
When posting to slack you must provide your slack services hook url at the CLI or in your .autorc config.
To configure the titles used in the changelog add changelogTitles to the .autorc.
{
"changelogTitles": {
"major": "Breaking",
"minor": "Feature",
"patch": "Fix",
"internal": "Internal",
"documentation": "Docz"
}
}
If you want more sections in your changelog to further detail the change set you can use the changelogTitles to add more.
{
"changelogTitles": {
"typescript": "Typescript Rewrite",
"front-end": "Front End Updates",
"back-end": "Back End Updates"
}
}
auto labelGet the labels for a pull request.
> auto label -h
usage: auto label.js [-h] --pr PR [--repo REPO] [--owner OWNER] [-v] [-vv]
[--githubApi GITHUBAPI]
Optional arguments:
-h, --help Show this help message and exit.
--pr PR The pull request number you want the labels of
--repo REPO The repo to set the status on. Defaults to looking in
the package.json
--owner OWNER Version number to publish as. Defaults to reading
from the package.json
-v, --verbose Show some more logs
-vv, --very-verbose Show a lot more logs
--githubApi GITHUBAPI
Github API to use
auto prSet the status on a PR commit
> auto pr -h
usage: auto pr.js [-h] [--sha SHA] --state STATE --description DESCRIPTION
--url URL --context CONTEXT --pr PR [--owner OWNER]
[--repo REPO] [-v] [-vv] [--githubApi GITHUBAPI]
Optional arguments:
-h, --help Show this help message and exit.
--sha SHA Specify a custom git sha. Defaults to the HEAD for a
git repo in the current repository
--state STATE State of the PR
--description DESCRIPTION
A description of the status
--url URL URL to associate with this status
--context CONTEXT A string label to differentiate this status from
others
--pr PR The pull request number you want the labels of
--owner OWNER Version number to publish as. Defaults to reading
from the package.json
--repo REPO The repo to set the status on. Defaults to looking in
the package.json
-v, --verbose Show some more logs
-vv, --very-verbose Show a lot more logs
--githubApi GITHUBAPI
Github API to use
auto pr-checkCheck that a pull request has a SemVer label.
> auto pr-check -h
usage: auto pr-check.js [-h] [--pr PR] [-d] --url URL
[--owner OWNER] [--repo REPO]
[--onlyPublishWithReleaseLabel] [--major MAJOR]
[--minor MINOR] [--patch PATCH] [-v] [-vv]
[--githubApi GITHUBAPI]
Optional arguments:
-h, --help Show this help message and exit.
--pr PR The PR number
-d, --dry-run Don't actually commit status. Just print the request
body
--url URL URL to associate with this status
--owner OWNER Version number to publish as. Defaults to reading
from the package.json
--repo REPO The repo to set the status on. Defaults to looking in
the package.json
--onlyPublishWithReleaseLabel
Only bump version if `release` label is on pull
request
--major MAJOR The name of the tag for a major version bump
--minor MINOR The name of the tag for a minor version bump
--patch PATCH The name of the tag for a patch version bump
-v, --verbose Show some more logs
-vv, --very-verbose Show a lot more logs
--githubApi GITHUBAPI
Github API to use
auto commentComment on a pull request with a markdown message.
> auto version -h
usage: auto comment.js [-h] -m MESSAGE [--context CONTEXT] [--owner OWNER]
[--repo REPO] --pr PR [-v] [-vv]
[--githubApi GITHUBAPI]
Optional arguments:
-h, --help Show this help message and exit.
-m MESSAGE, --message MESSAGE
Message to post to comment.
--context CONTEXT A string label to differentiate this status from
others
--owner OWNER Version number to publish as. Defaults to reading
from the package.json
--repo REPO The repo to set the status on. Defaults to looking in
the package.json
--pr PR The pull request number you want the labels of
-v, --verbose Show some more logs
-vv, --very-verbose Show a lot more logs
--githubApi GITHUBAPI
Github API to use
auto-release was built for use in a continuous integration environment. Here's how to set it up in various tools.
The following config declares the release job and uses it in the build_and_release workflow. The release job will only run on commits to master.
version: 2
defaults: &defaults
working_directory: ~/auto-release-test
docker:
- image: circleci/node:latest-browsers
jobs:
install: # your install job
release:
<<: *defaults
steps:
- attach_workspace:
at: ~/auto-release-test
- run:
name: Release
command: npm run publish
workflows:
version: 2
build_and_release:
jobs:
- install:
filters:
tags:
only: /.*/
- release:
requires:
- install
filters:
branches:
only:
- master
If you are using enterprise github auto-release lets you configure the github API URL that it uses. You can configure this by using the CLI option --githubApi or by setting the value in your .autorc.
v0.20.16 (Thu Dec 06 2018)
FAQs
CLI tools to help facilitate semantic versioning based on GitHub PR labels
The npm package auto-release-cli receives a total of 33 weekly downloads. As such, auto-release-cli popularity was classified as not popular.
We found that auto-release-cli demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.