Release Please

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

Release Please can be configured (using GitHub Actions,
a cron, or a step during CI/CD) to maintain a PR that represents the next release
or your library.

When the candidate PR is merged, Release Please can be configured to create
a GitHub Release.

Here's an example of Release Please in action.

The Release Please Repository:

• 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

Maintaining a Release PR

To configure Release Please to maintain an up-to-date release
pull-request on your repository, setup the following command to execute
when changes are pushed to master:

release-please release-pr --package-name=@google-cloud/firestore" \
  --repo-url=googleapis/nodejs-firestore \
  --token=$GITHUB_TOKEN

• --package-name: is the name of the package to publish to publish to
  an upstream registry such as npm.
• --repo-url: is the URL of the repository on GitHub.
• --token: a token with write access to --repo-url.

Creating GitHub Releases

To configure Release Please to generate GitHub Releases when release
pull-requests are merged to master, setup the following command to
execute when changes are pushed to master:

release-please github-release --repo-url=googleapis/nodejs-firestore \
  --token=$GITHUB_TOKEN

• --repo-url: is the URL of the repository on GitHub.
• --token: a token with write access to --repo-url.

GitHub Actions

An elegant way to configure Release Please is through
GitHub Actions. To generate a
main.workflow for Release Please, simply run:

release-please generate-action --package-name=@google-cloud/firestore"

• --package-name: is the name of the package to publish to publish to
  an upstream registry such as npm.

Versioning

This library follows Semantic Versioning.

This library is considered to be in beta. This means it is expected to be
mostly stable while we work toward a general availability release; however,
complete stability is not guaranteed. We will address issues and requests
against beta libraries with a high priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE