From c135d28df8c7eacf1ea9e8a5fa0666f730fbc8f1 Mon Sep 17 00:00:00 2001 From: Kevin Garner Date: Sat, 26 Aug 2023 14:33:44 -0500 Subject: [PATCH] Added RELEASE-README. --- RELEASE-README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 RELEASE-README.md diff --git a/RELEASE-README.md b/RELEASE-README.md new file mode 100644 index 0000000..f51de58 --- /dev/null +++ b/RELEASE-README.md @@ -0,0 +1,10 @@ +## `ts-markdown` Release Checklist + +1. Ensure all the changes for the next release are in `main` branch +1. Run the github action [Bump version](https://github.com/kgar/ts-markdown/actions/workflows/version-bump.yml) with the new target version +1. Review and approve the generated PR +1. Now that `main` branch is updated to the latest version, [draft a new release](https://github.com/kgar/ts-markdown/releases/new) +1. Select a new tag name that matches the new version +1. Generate release notes and add any extra notes for personalization +1. Publish the release + - This will trigger the github action [Publish to NPM](https://github.com/kgar/ts-markdown/actions/workflows/npm-publish.yml) and put the latest out there