Skip to content
This repository has been archived by the owner on Jun 10, 2024. It is now read-only.

Commit

Permalink
Update release checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
kfarr authored Nov 25, 2023
1 parent 7328028 commit 42be332
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ Then navigate to __[http://localhost:3333/](http://localhost:3333/)__

* after the above deployment instructions works on dev server (not deploy to production server yet)
* bump the version on package.json & package-lock.json (for example from 0.4.1 to 0.4.2)
* Update CHANGELOG.md with "Major improvement" changes summary (low level commits will be automatically generated by github in a later step) you can see notes of changes since last release on this view
* Commit this all to the repo
* Use command line to create new tag for new version `git tag 0.4.2` and `git push --tags`
* Make sure all of the above is committed and pushed to the repo
* Then do production deployment following above instructions with .env.production environment
* Create a new release here: https://github.com/3DStreet/3dstreet-editor/releases/new. Choose a tag, type in the new version such as "1.1" and for the title simply use the new version such as "1.1" or "1.1.0". Click "generate release notes." Copy and paste the "Major improvements" from the above summary above the generated release notes below.
* Create a new GitHub release here: https://github.com/3DStreet/3dstreet-editor/releases/new. Choose the tag you used above. (If needed for the title simply use the new version such as "1.1" or "1.1.0")
* Click to automatically "generate release notes." Consider summarizing a few key changes to put at the top.
* Update CHANGELOG.md with a quick summary of the auto generated release notes under the "Major improvement" heading.

0 comments on commit 42be332

Please sign in to comment.