From f458cdfb29713548ead1516d31a60e3033f959fc Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sun, 12 Nov 2023 19:09:27 +0200 Subject: [PATCH] Add release checklist (#98) Co-authored-by: Ezio Melotti Co-authored-by: Mariatta --- RELEASING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 RELEASING.md diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..e7b5d7c --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,29 @@ +# Release Checklist + +- [ ] check tests pass on [GitHub Actions](https://github.com/python/cherry-picker/actions) + [![GitHub Actions status](https://github.com/python/cherry-picker/actions/workflows/main.yml/badge.svg)](https://github.com/python/cherry-picker/actions/workflows/main.yml) + +- [ ] Update [changelog](https://github.com/python/cherry-picker#changelog) + +- [ ] Go to [Releases page](https://github.com/python/cherry-picker/releases) and + + - [ ] Click "Draft a new release" + + - [ ] Click "Choose a tag" + + - [ ] Type the next `cherry-picker-vX.Y.Z` version and select "**Create new tag: cherry-picker-vX.Y.Z** on publish" + + - [ ] Leave the "Release title" blank (it will be autofilled) + + - [ ] Click "Generate release notes" and amend as required + + - [ ] Click "Publish release" + +- [ ] Check the tagged [GitHub Actions build] (https://github.com/python/cherry-picker/actions/workflows/deploy.yml) + has deployed to [PyPI] (https://pypi.org/project/cherry_picker/#history) + +- [ ] Check installation: + +```bash +python -m pip uninstall -y cherry_picker && python -m pip install -U cherry_picker && cherry_picker --version +```