From 321c13096d5c5210e473e398d964a7fe92d545d5 Mon Sep 17 00:00:00 2001 From: Dora Do Date: Tue, 14 Jul 2026 17:34:57 -0400 Subject: [PATCH] fix: clarify wording and add missing steps in deploy instructions --- contributor_docs/release.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/contributor_docs/release.md b/contributor_docs/release.md index 0ede9dab33..ee96a2a07c 100644 --- a/contributor_docs/release.md +++ b/contributor_docs/release.md @@ -13,15 +13,21 @@ This project's release guide is based on: 1. `$ git checkout develop` 2. `$ git pull origin develop` 3. `$ git checkout -b release-` -4. Do all of the release branch testing necessary. This could be as simple as running `npm test:ci`, or it could take user testing over a few days. -5. `$ npm version ` (see [npm-version](https://docs.npmjs.com/cli/version) for valid values of ). +4. Do the necessary release branch testing: + 1. Run `$ npm run test:ci` + 2. Do user testing over a few days if necessary. +5. `$ npm version `, where `` can be `major`, `minor`, `patch`, etc. (see [npm-version](https://docs.npmjs.com/cli/version) for valid values of ``). 6. `$ git checkout release` 7. `$ git merge --no-ff release-` 8. `$ git push && git push --tags` 9. `$ git checkout develop` 10. `$ git merge --no-ff release-` -11. `$ git push origin develop` -12. [Draft a new release on Github](https://github.com/processing/p5.js-web-editor/releases/new). Choose the tag that is the release version you just created, and then title it `v`. Then click "Generate release notes". Publish the release and you are finished! +11. `$ git merge release` +12. `$ git push origin develop` +13. [Draft a new release on Github](https://github.com/processing/p5.js-web-editor/releases/new). Choose the tag that is the release version you just created, and then click "Generate release notes" (the title will be autogenerated as well) and publish the release. +14. Check that Github actions are running. +15. `$ kubectl get pods --namespace production` to check the pods are running (this might take a few minutes and you can rerun the command to check again). +16. Validate that [production](https://stagingeditor.p5js.org/) is working and you are finished! Travis CI will automatically deploy the release to production, as well as push a production tagged Docker image to DockerHub.