From 42be3322cfc5651524f8ef08ed2f1722b23c7d0c Mon Sep 17 00:00:00 2001 From: Kieran Farr Date: Fri, 24 Nov 2023 20:38:24 -0800 Subject: [PATCH] Update release checklist --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c62cb608..9a6bc12c 100644 --- a/README.md +++ b/README.md @@ -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.