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 of 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.
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
npm install release-please
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
.
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
.
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.
Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.
Client libraries targetting some end-of-life versions of Node.js are available, and
can be installed via npm dist-tags.
The dist-tags follow the naming convention legacy-(version)
.
Legacy Node.js versions are supported as a best effort:
- Legacy versions will not be tested in continuous integration.
- Some security patches may not be able to be backported.
- Dependencies will not be kept up-to-date, and features will not be backported.
-
legacy-8
: install client libraries from this dist-tag for versions compatible with Node.js 8.
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
Contributions welcome! See the Contributing Guide.
Please note that this README.md
, the samples/README.md
,
and a variety of configuration files in this repository (including .nycrc
and tsconfig.json
)
are generated from a central template. To edit one of these files, make an edit
to its template in this
directory.
Apache Version 2.0
See LICENSE