Skip to content

Commit 3e50eb6

Browse files
authored
chore: update release process in contributing docs (#445)
1 parent 5e5ef31 commit 3e50eb6

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,26 @@ Lastly, open a pull request on Github.
2121

2222
## Releasing
2323

24-
1. Merge the release PR
25-
2. Switch to the default branch `git checkout main`
26-
3. Pull latest changes `git pull`
27-
4. Publish the package `npm publish`
24+
This repo uses [semantic versioning](https://semver.org/) with the help of [release-please](https://github.com/googleapis/release-please).
25+
We use [release-please](https://github.com/googleapis/release-please) workflow for releases. The [workflow](./.github/workflows/release-please.yml) is responsible for:
26+
27+
- Creating release PRs
28+
- Once release PRs are merged it:
29+
- creates a release [tag](https://github.com/netlify/netlify-plugin-lighthouse/releases)
30+
- publishes the new version to [npm](https://www.npmjs.com/package/@netlify/plugin-lighthouse)
31+
- creates an update PR in [plugins](https://github.com/netlify/plugins)
32+
33+
Things to be aware of:
34+
35+
- use [conventional commits](https://www.conventionalcommits.org/)
36+
- Only `feat` and `fix` commits will be released. `chore` commits will not create a release PR
37+
- To jump versions e.g `v2.0` to `v3.0` make sure to indicate that in your PR by having a `Release-As` in the commit message e.g `Release-As: 3.0.0`. See ["How do I change the version number?"](https://github.com/googleapis/release-please#how-do-i-change-the-version-number) docs in release-please.
38+
39+
#### Steps
40+
41+
1. Merge your feature or bug fix PR
42+
2. Release please creates a release PR
43+
3. Merge the release PR
44+
4. Verify that the new version is available in npm
45+
5. Go to plugins and merge the version update PR
46+

0 commit comments

Comments
 (0)