From e058a5a6e7baa19fe4705c8903a0f2c8d3a4fe36 Mon Sep 17 00:00:00 2001 From: Chris Contolini Date: Wed, 4 Dec 2024 17:57:05 -0500 Subject: [PATCH] Update release documentation --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3e072841f..e76da4f5b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,13 +94,16 @@ Ready to publish changes to npm? First, set some credentials: -1. Export a personal access token called - [`GITHUB_AUTH`](https://github.com/lerna/lerna-changelog#github-token). +1. Create and export a personal access token called + [`GITHUB_TOKEN`](https://github.com/release-it/release-it/blob/main/docs/github-releases.md#automated). +1. Confirm your environment has the above token properly defined and is not blank: `echo $GITHUB_TOKEN`. 1. Create an npm account if you don't already have one and ensure you're listed as a "collaborator" on all our npm packages (e.g. [cfpb-buttons](https://www.npmjs.com/package/@cfpb/cfpb-buttons)). 1. Check that you are logged in with `npm whoami`. If you aren't shown your username, run `npm login`. +**Note:** If you run into issues with your npm account not approving your MFA code, try resetting your npm password at npmjs.com. + Then, do a release: 1. Ensure you're on the `main` branch with `git checkout main`