Release Please

release-please generates GitHub PRs for library releases, based on the conventionalcommits.org commit specification.

The generated PR:

determines the next version that a library should be released as (based on SemVer).
updates language-specifc files, .gemspec, package.json, setup.py, etc., with the appropriate version.
generates a CHANGELOG with information pertinent to library consumers.
adds labels to the PR, providing contextual information to automation tools furhter down the pipeline, e.g., autorelease: pending.
github.com/googleapis/release-please

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart
- Installing the client library
Versioning
Contributing
License

Quickstart

Installing the client library

npm install release-please

CLI Commands

When running CLI commands, set the GH_TOKEN environment variable to a token you've generated with write permissions for the repo you're interacting with.

Minting a Release

Generates a new release, based on the commit history since the last release that was tagged:

release-please mint-release  --repo-url=git@github.com:bcoe/my-fake-repo.git
  --package-name=@google-cloud/fake --release-type=node

--repo-url: the GitHub URL of the repository the release is being generated for.
--package-name: the name of the package that will ultimately be published (to npm, PyPi, RubyGems, etc.).
--release-type: what type of release is being created, possible values:
- node: a simple Node.js repo (not a mono-repo).

Versioning

This library follows Semantic Versioning.

This library is considered to be in alpha. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE

Current Tags

16.15.0 ... latest (a month ago)
6.9.4 ... latest-6 (4 years ago)
13.16.3 ... legacy-10 (3 years ago)
3.2.2 ... legacy-8 (5 years ago)
12.6.1 ... next (3 years ago)
6.4.2-candidate-1 ... otp-test (4 years ago)