Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add release please #110

Merged
merged 2 commits into from
Mar 18, 2021
Merged

chore: add release please #110

merged 2 commits into from
Mar 18, 2021

Conversation

erezrokah
Copy link

This is what we use in our team for release automation.

It takes care of versioning, changelog generation, tagging and publishing GitHub releases.

On each commit to main release-please checks if there is something that justifies a release, based on conventional commit messages and then creates a relevant release PR (e.g netlify/cli#1969).

Once the release PR is merged release-please tags the commit and creates a GitHub release.

To make this work, it requires writing commit messages in a specific way. See here for more information.

There are other ways to automate releases, but we like this one as it doesn't require pushing directly to the default branch.

PR is at draft to get some feedback.

@erezrokah erezrokah added the type: chore work needed to keep the product and development running smoothly label Mar 10, 2021
@erezrokah erezrokah self-assigned this Mar 11, 2021
@erezrokah erezrokah force-pushed the chore/add_release_please branch from cd6513b to f3cca42 Compare March 14, 2021 17:24
RELEASE.md Outdated
# Releasing

1. Merge the release PR
2. Run `npm publish`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we add https://github.com/googleapis/release-please#how-should-i-write-my-commits and general instructions to this doc?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure I'll add the instructions

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I replaced this with a contributing guide, please let me know what you think

@lindsaylevine
Copy link

  1. will this extend our previous CHANGELOG?
  2. what else is needed for review/feedback to get this out of draft mode? :)

@erezrokah erezrokah force-pushed the chore/add_release_please branch from f3cca42 to 688eed7 Compare March 18, 2021 16:30
@erezrokah erezrokah marked this pull request as ready for review March 18, 2021 16:31
@erezrokah
Copy link
Author

  1. will this extend our previous CHANGELOG?

It should

2. what else is needed for review/feedback to get this out of draft mode? :)

Marked it ready

@erezrokah erezrokah requested a review from lindsaylevine March 18, 2021 17:11
Copy link

@lindsaylevine lindsaylevine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome ty!!!!!!!

@erezrokah erezrokah merged commit 1c6bba7 into main Mar 18, 2021
@erezrokah erezrokah deleted the chore/add_release_please branch March 18, 2021 17:41
ascorbic pushed a commit that referenced this pull request Oct 14, 2021
ascorbic added a commit that referenced this pull request Oct 14, 2021
* chore: add release please (#110)

* chore(release-please): use GitHub app token (#203)

* fix: update repo

* chore: add fossa

* chore: add node 12 test

* chore: update readme

* fix: update tests to support node 12

* chore: add bug report form

Co-authored-by: Erez Rokah <[email protected]>
Co-authored-by: Kristy Marcinova <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: chore work needed to keep the product and development running smoothly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants