diff --git a/.github/ISSUE_TEMPLATE/create-release.md b/.github/ISSUE_TEMPLATE/create-release.md new file mode 100644 index 00000000..211f1c6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/create-release.md @@ -0,0 +1,35 @@ +--- +name: Create Release +about: Create a new release of the AI-Lab +title: "\U0001F4E6 Create Release " +labels: task +assignees: '' + +--- + +* [ ] Adjust version number in file `pyproject.toml` + +If you decided to change the version number then +* [ ] Run `poetry run version-check --fix` (only when using PTB) +* [ ] Rename latest file `doc/changes/changes_*.md` accordingly +* [ ] Update reference in file `doc/changes/changelog.md` +* [ ] Update version number in latest file `doc/changes/changes_*.md` + +Always +* latest file `doc/changes/changes_*.md` + * [ ] Append release date to first line + * [ ] Add a code name and a summary +* Update version number in user guide + * [ ] `user_guide/docker/docker-usage.md` + * [ ] `user_guide/vm-edition/win-vbox.md` +* Update version number in developer guide + * [ ] `testing.md` + +Ship the Actual Release +* [ ] Run release droid `java -jar ~/java/jar/release-droid-*.jar -n ai-lab --goal release` +* [ ] Edit the Release on GitHub making the draft final +* [ ] Fill out Release Checklist in company wiki +* [ ] Announce Release in company chat channel "global product news" + +Post-Release Actions +* [ ] Update links in file `README.md` to point to the tag on GitHub