From 4bc26344938c796e4bcad53032786922a967c3f3 Mon Sep 17 00:00:00 2001 From: Vanita Barrett-Smith Date: Fri, 10 Jun 2022 14:57:50 +0100 Subject: [PATCH] Use 'npm' instead of 'NPM' --- bin/publish-release.sh | 10 +++++----- docs/releasing/publishing.md | 6 +++--- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/bin/publish-release.sh b/bin/publish-release.sh index 320c94f574..e0320f31c5 100755 --- a/bin/publish-release.sh +++ b/bin/publish-release.sh @@ -3,24 +3,24 @@ set -e source ./bin/generate-npm-tag.sh -# Check NPM tag looks as expected +# Check npm tag looks as expected # https://npm.github.io/publishing-pkgs-docs/updating/using-tags.html#publishing-with-tags -echo "This will publish the package with the following NPM tag:" +echo "This will publish the package with the following npm tag:" echo $NPM_TAG echo " " read -r -p "Does this look correct? [y/N] " continue_prompt if [[ $continue_prompt != 'y' ]]; then - read -r -p "What should the NPM tag be: " NPM_TAG + read -r -p "What should the npm tag be: " NPM_TAG fi echo "Starting a release..." echo " " echo "This will:" echo "- check that you're logged in to npm as the correct user" -echo "- publish the package to NPM if it has not been published already" -echo "- tag the package on NPM with '$NPM_TAG'" +echo "- publish the package to npm if it has not been published already" +echo "- tag the package on npm with '$NPM_TAG'" echo "- check that there is not already a Github tag published" echo "- create a new Github tag" echo "- push the Github tag to remote origin" diff --git a/docs/releasing/publishing.md b/docs/releasing/publishing.md index 87f7842a94..366e71c667 100644 --- a/docs/releasing/publishing.md +++ b/docs/releasing/publishing.md @@ -5,7 +5,7 @@ 2. Developers to raise new issues in the team GitHub repositories ([govuk-frontend](https://github.com/alphagov/govuk-frontend), [govuk-frontend-docs](https://github.com/alphagov/govuk-frontend-docs), [govuk-prototype-kit](https://github.com/alphagov/govuk-prototype-kit)) to: - draft comms for the new release (example issue: [#2507](https://github.com/alphagov/govuk-frontend/issues/2507)) - create release notes for the new release (example issue: [#2508](https://github.com/alphagov/govuk-frontend/issues/2508)) - - release the new version of GOV.UK Frontend to NPM (example issue: [#2509](https://github.com/alphagov/govuk-frontend/issues/2509)) + - release the new version of GOV.UK Frontend to npm (example issue: [#2509](https://github.com/alphagov/govuk-frontend/issues/2509)) - update the GOV.UK Design System to use the new release of GOV.UK Frontend (example issue: [#2024](https://github.com/alphagov/govuk-design-system/issues/2024)) - update the GOV.UK Frontend Docs to use the new release of GOV.UK Frontend (example issue: [#184](https://github.com/alphagov/govuk-frontend-docs/issues/184)) - post the comms and do tidy-up tasks (example issue: [#2510](https://github.com/alphagov/govuk-frontend/issues/2510)) @@ -78,12 +78,12 @@ Developers should pair on releases. When remote working, it can be useful to be 2. Sign in to npm (`npm login`), using the npm/govuk-patterns-and-tools team [credentials](https://github.com/alphagov/design-system-team-credentials/tree/main/npm/govuk-patterns-and-tools). -3. Run `npm run publish-release`, which will prompt you to check whether the NPM tag looks as expected. +3. Run `npm run publish-release`, which will prompt you to check whether the npm tag looks as expected. If you're following these instructions, you're probably doing a sequential release, meaning the tag should be 'latest'. - Enter `y` to continue. If you think the tag should be different, enter `N` to have the option to set your own NPM tag. + Enter `y` to continue. If you think the tag should be different, enter `N` to have the option to set your own npm tag. 4. You will now be prompted to continue or cancel the release. Check the details and enter `y` to continue. If something does not look right, press `N` to cancel the release.