Skip to content

Commit a49a402

Browse files
authored
Updates for clarify
1 parent 9f379f2 commit a49a402

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

‎RELEASE.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Do every step below for each release, unless indicated otherwise.
1212
- Run `git switch main && git pull`
1313
- Run `git status` and confirm that the working tree is clean
1414
- Run `git switch -c release-vX.Y.Z`, where `X.Y.Z` is the new version number
15-
- Run `npx check-node-version --node 22 --npm 10`
15+
- Run `npx check-node-version --node 22 --npm 10` to confirm the tooling versions before you install
1616
- Run `npm ci`
1717
- Run `npm run preversion`
1818
- Update the version number and the release date in [README.md](README.md) and [CITATION.cff](CITATION.cff). Skip this step for a release candidate.
@@ -28,7 +28,7 @@ Do every step below for each release, unless indicated otherwise.
2828
- Correct typos and add missing entries and extra details
2929
- Open `https://github.com/plotly/plotly.js/compare/vX.Y.Q...main` to view every commit since the previous release `vX.Y.Q`
3030
- Confirm that every draftlog entry uses the link template `[[#1234](https://github.com/plotly/plotly.js/pull/1234)]`
31-
- Credit a community contributor at the end of that entry: **', with thanks to @plotly-user for the contribution!'**
31+
- Credit a community contributor at the end of that entry: **', with thanks to @<USERNAME> for the contribution!'**
3232
- Run `npm run empty-draftlogs` to empty the `draftlogs/` folder. Skip this step for a release candidate.
3333
- Run `git add -u . && git commit -m "chore: Updates for release vX.Y.Z"`
3434

@@ -61,7 +61,7 @@ Do every step below for each release, unless indicated otherwise.
6161
## Publish the release
6262

6363
- Run `git switch main && git pull` after the pull request merges
64-
- Run `git describe --tags` and confirm that the output reads `vX.Y.Z`
64+
- Run `git branch --contains vX.Y.Z` and confirm that the output includes `main`
6565

6666
### Publish to npm
6767

@@ -85,8 +85,10 @@ Do every step below for each release, unless indicated otherwise.
8585
8686
### Publish to the Plotly CDN
8787

88-
- Run `which aws` to determine if the AWS CLI is installed on your system
89-
- If the command returns no path, install the CLI. You can run `pip install awscli`, or `brew install awscli` on macOS.
88+
- Run `aws --version` and confirm that the output starts with `aws-cli/2`
89+
- If the command is not found, or the output shows version 1, install AWS CLI v2:
90+
- On macOS, run `brew install awscli`
91+
- On Linux or Windows, follow the [AWS CLI install guide](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
9092
- Run `./tasks/cdn_publish.sh` to upload the new release files to the CDN bucket on S3
9193
- If that step fails with an authentication error, run `aws configure` and enter the credentials for the plotly.js CDN bucket
9294

0 commit comments

Comments
 (0)