Skip to content

fix: clarify wording and add missing steps in deploy instructions #4205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
doradocodes wants to merge 1 commit into
base: develop
Choose a base branch
from
+10 −4
Open

fix: clarify wording and add missing steps in deploy instructions #4205

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions contributor_docs/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-<newversion>`
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 <newversion>` (see [npm-version](https://docs.npmjs.com/cli/version) for valid values of <newversion>).
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 <versiontype>`, where `<versiontype>` can be `major`, `minor`, `patch`, etc. (see [npm-version](https://docs.npmjs.com/cli/version) for valid values of `<versiontype>`).
6. `$ git checkout release`
7. `$ git merge --no-ff release-<newversion>`
8. `$ git push && git push --tags`
9. `$ git checkout develop`
10. `$ git merge --no-ff release-<newversion>`
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<newversion>`. 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!

@raclim raclim Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I might include checking the staging environment in Step 4!


Travis CI will automatically deploy the release to production, as well as push a production tagged Docker image to DockerHub.

Expand Down
Loading