• Stars
    star
    4,740
  • Rank 8,918 (Top 0.2 %)
  • Language
    TypeScript
  • License
    Apache License 2.0
  • Created over 5 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

generate release PRs based on the conventionalcommits.org spec

Google Cloud Platform logo

Release Please

npm version codecov

Release Please automates CHANGELOG generation, the creation of GitHub releases, and version bumps for your projects.

It does so by parsing your git history, looking for Conventional Commit messages, and creating release PRs.

It does not handle publication to package managers or handle complex branch management.

What's a Release PR?

Rather than continuously releasing what's landed to your default branch, release-please maintains Release PRs:

These Release PRs are kept up-to-date as additional work is merged. When you're ready to tag a release, simply merge the release PR. Both squash-merge and merge commits work with Release PRs.

When the Release PR is merged, release-please takes the following steps:

  1. Updates your changelog file (for example CHANGELOG.md), along with other language specific files (for example package.json).
  2. Tags the commit with the version number
  3. Creates a GitHub Release based on the tag

You can tell where the Release PR is in its lifecycle by the status label on the PR itself:

  • autorelease: pending is the initial state of the Release PR before it is merged
  • autorelease: tagged means that the Release PR has been merged and the release has been tagged in GitHub
  • autorelease: snapshot is a special state for snapshot version bumps
  • autorelease: published means that a GitHub release has been published based on the Release PR (release-please does not automatically add this tag, but we recommend it as a convention for publication tooling).

How should I write my commits?

Release Please assumes you are using Conventional Commit messages.

The most important prefixes you should have in mind are:

  • fix: which represents bug fixes, and correlates to a SemVer patch.
  • feat: which represents a new feature, and correlates to a SemVer minor.
  • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

Linear git commit history (use squash-merge)

We highly recommend that you use squash-merges when merging pull requests. A linear git history makes it much easier to:

  • Follow history - commits are sorted by merge date and are not mixed between pull requests
  • Find and revert bugs - git bisect is helpful for tracking down which change introduced a bug
  • Control the release-please changelog - when you merge a PR, you may have commit messages that make sense within the scope of the PR, but don't make sense when merged in the main branch. For example, you make have feat: introduce feature A and then fix: some bugfix introduced in the first commit. The fix commit is actually irrelevant to the release notes as there was never a bug experienced in the main branch.
  • Keep a clean main branch - if you use something like red/green development (create a failing test in commit A, then fix in commit B) and merge (or rebase-merge), then there will be points in time in your main branch where tests do not pass.

What if my PR contains multiple fixes or features?

Release Please allows you to represent multiple changes in a single commit, using footers:

feat: adds v4 UUID to crypto

This adds support for v4 UUIDs to the library.

fix(utils): unicode no longer throws exception
  PiperOrigin-RevId: 345559154
  BREAKING-CHANGE: encode method no longer throws.
  Source-Link: googleapis/googleapis@5e0dcb2

feat(utils): update encode to support unicode
  PiperOrigin-RevId: 345559182
  Source-Link: googleapis/googleapis@e5eef86

The above commit message will contain:

  1. an entry for the "adds v4 UUID to crypto" feature.
  2. an entry for the fix "unicode no longer throws exception", along with a note that it's a breaking change.
  3. an entry for the feature "update encode to support unicode".

โš ๏ธ Important: The additional messages must be added to the bottom of the commit.

How do I change the version number?

When a commit to the main branch has Release-As: x.x.x (case insensitive) in the commit body, Release Please will open a new pull request for the specified version.

Empty commit example:

git commit --allow-empty -m "chore: release 2.0.0" -m "Release-As: 2.0.0" results in the following commit message:

chore: release 2.0.0

Release-As: 2.0.0

How can I fix release notes?

If you have merged a pull request and would like to amend the commit message used to generate the release notes for that commit, you can edit the body of the merged pull requests and add a section like:

BEGIN_COMMIT_OVERRIDE
feat: add ability to override merged commit message

fix: another message
chore: a third message
END_COMMIT_OVERRIDE

The next time Release Please runs, it will use that override section as the commit message instead of the merged commit message.

โš ๏ธ Important: This feature will not work with plain merges because release-please does not know which commit(s) to apply the override to. We recommend using squash-merge instead.

Release Please bot does not create a release PR. Why?

Step 1: Ensure releasable units are merged

Release Please creates a release pull request after it notices the default branch contains "releasable units" since the last release. A releasable unit is a commit to the branch with one of the following prefixes: "feat", "fix", and "deps". (A "chore" or "build" commit is not a releasable unit.)

Some languages have their specific releasable unit configuration. For example, "docs" is a prefix for releasable units in Java and Python.

Step 2: Ensure no autorelease: pending or autorelease: triggered label in an old PR

Check existing pull requests labelled with autorelease: pending or autorelease: triggered label. Due to GitHub API failures, it's possible that the tag was not removed correctly upon a previous release and Release Please thinks that the previous release is still pending. If you're certain that there's no pending release, remove the autorelease: pending or autorelease: triggered label.

For the GitHub application users, Release Please will not create a new pull request if there's an existing pull request labeled as autorelease: pending. To confirm this case, search for a pull request with the label. (It's very likely it's the latest release pull request.) If you find a release pull request with the label and it is not going to be released (or already released), then remove the autorelease: pending label and re-run Release Please.

Step 3: Rerun Release Please

If you think Release Please missed creating a release PR after a pull request with a releasable unit has been merged, please re-run release-please. If you are using the GitHub application, add release-please:force-run label to the merged pull request. If you are using the action, look for the failed invocation and retry the workflow run. Release Please will process the pull request immediately to find releasable units.

Strategy (Language) types supported

Release Please automates releases for the following flavors of repositories:

release type description
dart A repository with a pubspec.yaml and a CHANGELOG.md
elixir A repository with a mix.exs and a CHANGELOG.md
go A repository with a CHANGELOG.md
helm A repository with a Chart.yaml and a CHANGELOG.md
java A strategy that generates SNAPSHOT version after each release
krm-blueprint A kpt package, with 1 or more KRM files and a CHANGELOG.md
maven Strategy for Maven projects, generates SNAPSHOT version after each release and updates pom.xml automatically
node A Node.js repository, with a package.json and CHANGELOG.md
expo An Expo based React Native repository, with a package.json, app.json and CHANGELOG.md
ocaml An OCaml repository, containing 1 or more opam or esy files and a CHANGELOG.md
php A repository with a composer.json and a CHANGELOG.md
python A Python repository, with a setup.py, setup.cfg, CHANGELOG.md and optionally a pyproject.toml and a <project>/__init__.py
ruby A repository with a version.rb and a CHANGELOG.md
rust A Rust repository, with a Cargo.toml (either as a crate or workspace, although note that workspaces require a manifest driven release and the "cargo-workspace" plugin) and a CHANGELOG.md
sfdx A repository with a sfdx-project.json and a CHANGELOG.md
simple A repository with a version.txt and a CHANGELOG.md
terraform-module A terraform module, with a version in the README.md, and a CHANGELOG.md

Setting up Release Please

There are a variety of ways you can deploy release-please:

GitHub Action (recommended)

The easiest way to run Release Please is as a GitHub action. Please see google-github-actions/release-please-action for installation and configuration instructions.

Running as CLI

Please see Running release-please CLI for all the configuration options.

Install the GitHub App

There is a probot application available, which allows you to deploy Release Please as a GitHub App. Please see github.com/googleapis/repo-automation-bots for installation and configuration instructions.

Bootstrapping your Repository

Release Please looks at commits since your last release tag. It may or may not be able to find your previous releases. The easiest way to onboard your repository is to bootstrap a manifest config.

Customizing Release Please

Release Please provides several configuration options to allow customizing your release process. Please see customizing.md for more details.

Supporting Monorepos via Manifest Configuration

Release Please also supports releasing multiple artifacts from the same repository. See more at manifest-releaser.md.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

Client libraries targeting 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 tags available

  • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

Contributing

Contributions welcome! See the Contributing Guide.

For more information on the design of the library, see design.

Troubleshooting

For common issues and help troubleshooting your configuration, see Troubleshooting.

License

Apache Version 2.0

See LICENSE

More Repositories

1

google-api-nodejs-client

Google's officially supported Node.js client library for accessing Google APIs. Support for authorization and authentication with OAuth 2.0, API Keys and JWT (Service Tokens) is included.
TypeScript
11,377
star
2

google-api-php-client

A PHP client library for accessing Google APIs
PHP
8,706
star
3

google-api-python-client

๐Ÿ The official Python client library for Google's discovery based APIs.
Python
6,858
star
4

googleapis

Public interface definitions of Google APIs.
Starlark
6,797
star
5

google-cloud-python

Google Cloud Client Library for Python
Python
4,324
star
6

google-api-go-client

Auto-generated Google APIs for Go.
Go
3,572
star
7

google-cloud-go

Google Cloud Client Libraries for Go.
Go
3,361
star
8

google-api-ruby-client

REST client for Google APIs
Ruby
2,679
star
9

google-cloud-node

Google Cloud Client Library for Node.js
TypeScript
2,654
star
10

google-cloud-java

Google Cloud Client Library for Java
Java
1,773
star
11

google-auth-library-nodejs

๐Ÿ”‘ Google Auth Library for Node.js
TypeScript
1,549
star
12

google-http-java-client

Google HTTP Client Library for Java
Java
1,342
star
13

google-api-dotnet-client

Google APIs Client Library for .NET
C#
1,340
star
14

google-api-java-client

Google APIs Client Library for Java
Java
1,336
star
15

google-auth-library-php

Google Auth Library for PHP
PHP
1,323
star
16

google-cloud-ruby

Google Cloud Client Library for Ruby
Ruby
1,293
star
17

google-api-php-client-services

PHP
1,179
star
18

google-cloud-php

Google Cloud Client Library for PHP
PHP
1,085
star
19

elixir-google-api

Elixir client libraries for accessing Google APIs.
Elixir
1,011
star
20

google-cloud-dotnet

Google Cloud Client Libraries for .NET
C#
929
star
21

nodejs-storage

Node.js client for Google Cloud Storage: unified object storage for developers and enterprises, from live data serving to data analytics/ML to data archiving.
TypeScript
828
star
22

oauth2client

This is a Python library for accessing resources protected by OAuth 2.0.
Python
795
star
23

nodejs-dialogflow

Node.js client for Dialogflow: Design and integrate a conversational user interface into your applications and devices.
JavaScript
793
star
24

google-auth-library-python

Google Auth Python Library
Python
744
star
25

python-bigquery

Python
739
star
26

gaxios

An HTTP request client that provides an axios like interface over top of node-fetch. Super lightweight. Supports proxies and all sorts of other stuff.
TypeScript
692
star
27

nodejs-speech

This repository is deprecated. All of its content and history has been moved to googleapis/google-cloud-node.
684
star
28

python-aiplatform

A Python SDK for Vertex AI, a fully managed, end-to-end platform for data science and machine learning.
Python
626
star
29

repo-automation-bots

A collection of bots, based on probot, for performing common maintenance tasks across the open-source repos managed by Google on GitHub.
TypeScript
613
star
30

nodejs-firestore

Node.js client for Google Cloud Firestore: a NoSQL document database built for automatic scaling, high performance, and ease of application development.
JavaScript
612
star
31

google-oauth-java-client

Google OAuth Client Library for Java
Java
606
star
32

api-linter

A linter for APIs defined in protocol buffers.
Go
575
star
33

go-genproto

Generated code for Google Cloud client libraries.
Go
558
star
34

google-cloud-cpp

C++ Client Libraries for Google Cloud Services
C++
538
star
35

nodejs-pubsub

Node.js client for Google Cloud Pub/Sub: Ingest event streams from anywhere, at any scale, for simple, reliable, real-time stream analytics.
TypeScript
519
star
36

nodejs-translate

Node.js client for Google Cloud Translate: Dynamically translate text between thousands of language pairs.
JavaScript
514
star
37

nodejs-vision

Node.js client for Google Cloud Vision: Derive insight from images.
TypeScript
497
star
38

google-api-java-client-services

Generated Java code for Google APIs
497
star
39

python-bigquery-pandas

Google BigQuery connector for pandas
Python
447
star
40

python-bigquery-sqlalchemy

SQLAlchemy dialect for BigQuery
Python
426
star
41

nodejs-bigquery

Node.js client for Google Cloud BigQuery: A fast, economical and fully-managed enterprise data warehouse for large-scale data analytics.
TypeScript
420
star
42

google-auth-library-ruby

Google Auth Library for Ruby
Ruby
417
star
43

google-auth-library-java

Open source Auth client library for Java
Java
400
star
44

python-dialogflow

This library has moved to https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-dialogflow
397
star
45

python-pubsub

Python
390
star
46

signet

Signet is an OAuth 1.0 / OAuth 2.0 implementation.
Ruby
364
star
47

nodejs-text-to-speech

Node.js client for Google Cloud Text-to-Speech
JavaScript
355
star
48

python-speech

This library has moved to https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-speech
355
star
49

python-storage

Python
339
star
50

google-cloud-php-storage

PHP
322
star
51

google-cloud-php-core

PHP
319
star
52

gapic-generator

Tools for generating API client libraries from API Service Configuration descriptions.
Java
304
star
53

cloud-trace-nodejs

Node.js agent for Cloud Trace: automatically gather latency data about your application
TypeScript
272
star
54

gapic-generator-go

Generate Go API client libraries from Protocol Buffers.
Go
252
star
55

gax-php

Google API Extensions for PHP
PHP
232
star
56

api-common-protos

A standard library for use in specifying protocol buffer APIs.
Starlark
221
star
57

python-firestore

Python
214
star
58

google-cloud-datastore

Low-level, Protobuf-based Java and Python client libraries for Cloud Datastore. Check out google-cloud-java and google-cloud-python first!
Python
213
star
59

nodejs-datastore

Node.js client for Google Cloud Datastore: a highly-scalable NoSQL database for your web and mobile applications.
TypeScript
196
star
60

google-cloud-php-translate

PHP
194
star
61

python-bigquery-dataframes

BigQuery DataFrames
Python
186
star
62

google-cloud-rust

Rust
183
star
63

gapic-showcase

An API that demonstrates Generated API Client (GAPIC) features and common API patterns used by Google.
Go
174
star
64

github-repo-automation

A set of tools to automate multiple GitHub repository management.
TypeScript
174
star
65

google-cloud-php-firestore

PHP
170
star
66

cloud-debug-nodejs

Node.js agent for Google Cloud Debugger: investigate your codeโ€™s behavior in production
TypeScript
169
star
67

java-bigtable-hbase

Java libraries and HBase client extensions for accessing Google Cloud Bigtable
Java
165
star
68

gax-java

This library has moved to https://github.com/googleapis/sdk-platform-java/tree/main/gax-java.
162
star
69

python-vision

This library has moved to https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-vision
160
star
70

google-auth-library-python-oauthlib

Python
160
star
71

nodejs-logging

Node.js client for Stackdriver Logging: Store, search, analyze, monitor, and alert on log data and events from Google Cloud Platform and Amazon Web Services (AWS).
TypeScript
156
star
72

nodejs-tasks

Node.js client for Google Cloud Tasks: A fully managed service that allows you to manage the execution, dispatch and delivery of a large number of distributed tasks.
TypeScript
144
star
73

python-ndb

Python
144
star
74

google-cloudevents

Types for CloudEvents issued by Google
JavaScript
142
star
75

common-protos-php

PHP protocol buffer classes generated from https://github.com/googleapis/api-common-protos
PHP
132
star
76

artman

Artifact Manager, a build and packaging tool for Google API client libraries.
Python
132
star
77

proto-plus-python

Beautiful, idiomatic protocol buffers in Python
Python
132
star
78

googleapis.github.io

The GitHub pages site for the googleapis organization.
HTML
131
star
79

nodejs-language

Node.js client for Google Cloud Natural Language: Derive insights from unstructured text using Google machine learning.
JavaScript
131
star
80

java-pubsub

Java
126
star
81

python-analytics-data

Python
125
star
82

gapic-generator-python

Generate Python API client libraries from Protocol Buffers.
Python
122
star
83

google-auth-library-swift

Auth client library for Swift command-line tools and cloud services. Supports OAuth1, OAuth2, and Google Application Default Credentials.
Swift
122
star
84

python-api-core

Python
118
star
85

nodejs-compute

Node.js client for Google Compute Engine: Scalable, High-Performance Virtual Machines
JavaScript
115
star
86

python-texttospeech

Python
111
star
87

nodejs-spanner

Node.js client for Google Cloud Spanner: the worldโ€™s first fully managed relational database service to offer both strong consistency and horizontal scalability.
TypeScript
111
star
88

java-bigquery

Java
109
star
89

node-gtoken

๐Ÿ”‘ Google Auth Service Account Tokens for Node.js
TypeScript
108
star
90

python-translate

This library has moved to https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-translate
108
star
91

java-storage

Java
104
star
92

go-sql-spanner

Google Cloud Spanner driver for Go's database/sql package.
Go
104
star
93

google-cloud-php-vision

PHP
103
star
94

gax-nodejs

Google API Extensions for Node.js
TypeScript
100
star
95

java-firestore

Java
100
star
96

nodejs-logging-winston

Node.js client integration between Stackdriver Logging and Winston.
TypeScript
100
star
97

python-logging

Python
99
star
98

nodejs-bigtable

Node.js client for Google Cloud Bigtable: Google's NoSQL Big Data database service.
TypeScript
91
star
99

nodejs-secret-manager

A cloud-hosted service that provides a secure and convenient tool for storing API keys, passwords, certificates, and other sensitive data.
JavaScript
89
star
100

synthtool

Python
87
star