Skip to content

Commit 17773f5

Browse files
authored
docs: Add in sections for publishing releases (#92)
Complete publishing release section in contributing guidelines.
1 parent f77ce15 commit 17773f5

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,37 @@ Our different types of reviews:
7272

7373
## Publishing a Release
7474

75-
**TBD**
75+
We use the [changesets](https://github.com/changesets/changesets) CLI tool to manage our versions for the Codecov Bundler Plugins.
7676

7777
### Updating the Changelog
7878

79-
**TBD**
79+
To add a new changelog for the plugins you can run the following command:
80+
81+
```shell
82+
pnpm run changeset:add
83+
```
84+
85+
This will prompt you to select the bundles that will have their version updated
86+
when running the `prepare-publish` workflow. To keep the plugins all inline, you
87+
will need to select all of the plugins, even if you only changed one.
88+
89+
After confirming your selections, you will have to determine what kind of change
90+
your new release will be: `major`, `minor`, or `patch`. You can read more [here](https://semver.org/)
91+
to understand when and which change version to select.
92+
93+
You will then be prompted to enter a description as to what your changes do. When
94+
a release is cut and published these will be added to a list in the changelog
95+
informing developers what changes occurred in that release.
96+
97+
### Steps to create a new release
98+
99+
1. After your PR is approved and merged into the `main` branch, navigate to the
100+
`[prepare-publish](https://github.com/codecov/codecov-javascript-bundler-plugins/actions/workflows/prepare-publish.yml)` action, and run the action on the `main` branch. This will
101+
create a new pull request that when merged will publish a new version of the
102+
plugins.
103+
2. Navigate to the pull request that was created by the `prepare-publish`.
104+
Because of some limitations around GitHub Actions, you will have to manually
105+
open and close the PR to get the CI to fully run and pass the status checks.
106+
3. Once all of the status checks have passed, you will be able to merge your pull
107+
request. After merging the pull request, a workflow will run that will automatically
108+
publish the packages to NPM, and create a GitHub release.

0 commit comments

Comments
 (0)