Skip to content

[FEATURE] Use release-please to make releases #282

@gustavkj

Description

@gustavkj

Is your feature request related to a problem? Please describe.
it can be hard to know what changes are coming in the next release and can be nice to have an automated release system. But you don't want releases for every single little dependency bump.

Describe the solution you'd like

To make it easier to make releases and get a preview of what will be released in an upcoming release, release-please can be used to create a PR previewing the changes in an upcoming release.

When you want to make the release the release PR is simply merged and the release will be created (and published to npm if that's configured).

The version numbers are determined based on the commit messages as long as they adhere to Conventional Commits. So, for example feat!: change default behavior would create a release PR for a new major release as it has the ! in the message.

Describe alternatives you've considered
It would be possible to automate releases on every commit with a fix and feat type in the commit message. But this would be very noisy for the repositories using the package as there would be a lot of releases with changes they do not care about.

Additional context
The easiest way to use release-please is to set up the Github Action: https://github.com/google-github-actions/release-please-action

Here's example what a release PR can look like: lindell/aoc-loader#85

Screenshot 2022-05-05 at 10 24 41

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions