python-ring-doorbell · sdb9696 · Aug 21, 2024 · Aug 21, 2024
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
diff --git a/.github_changelog_generator b/.github_changelog_generator
@@ -0,0 +1,10 @@
+output=CHANGELOG.md
+user=tchellomello
+project=python-ring-doorbell
+release_branch=master
+usernames-as-github-logins=true
+breaking_labels=breaking change
+add-sections={"new-device":{"prefix":"**Added support for devices:**","labels":["new device"]},"docs":{"prefix":"**Documentation updates:**","labels":["documentation"]},"maintenance":{"prefix":"**Project maintenance:**","labels":["maintenance"]}}
+exclude-labels=duplicate,question,invalid,wontfix,release-prep,stale
+issues-wo-labels=false
+unreleased=false
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/RELEASING.md b/RELEASING.md
@@ -0,0 +1,166 @@
+# Releasing
+
+## Requirements
+* [github client](https://github.com/cli/cli#installation)
+* [gitchub_changelog_generator](https://github.com/github-changelog-generator)
+* [github access token](https://github.com/github-changelog-generator/github-changelog-generator#github-token)
+
+## Export changelog token
+
+```bash
+export CHANGELOG_GITHUB_TOKEN=token
+```
+
+## Set release information
+
+```bash
+export NEW_RELEASE=x.x.x
+```
+
+## Normal releases from master
+
+### Create a branch for the release
+
+```bash
+git checkout master
+git fetch upstream master
+git rebase upstream/master
+git checkout -b release/$NEW_RELEASE
+```
+
+### Update the version number
+
+```bash
+poetry version $NEW_RELEASE
+```
+
+### Update dependencies
+
+```bash
+poetry install --all-extras --sync
+poetry update
+```
+
+### Run pre-commit and tests
+
+```bash
+pre-commit run --all-files
+pytest
+```
+
+### Create release summary (skip for dev releases)
+
+Write a short and understandable summary for the release.  Can include images.
+
+#### Create $NEW_RELEASE milestone in github
+
+If not already created
+
+#### Create new issue linked to the milestone
+
+```bash
+gh issue create --label "release-summary" --milestone $NEW_RELEASE --title "$NEW_RELEASE Release Summary" --body "**Release highlights:**"
+```
+
+You can exclude the --body option to get an interactive editor or go into the issue on github and edit there.
+
+#### Close the issue
+
+Either via github or:
+
+```bash
+gh issue close ISSUE_NUMBER
+```
+
+### Generate changelog
+
+Configuration settings are in `.github_changelog_generator`
+
+#### For pre-release
+
+EXCLUDE_TAGS will exclude all dev tags except for the current release dev tags.
+
+Regex should be something like this `^((?!0\.9\.0)(.*dev\d))+`. The first match group negative matches on the current release and the second matches on releases ending with dev.
+
+```bash
+EXCLUDE_TAGS=${NEW_RELEASE%.dev*}; EXCLUDE_TAGS=${EXCLUDE_TAGS//"."/"\."}; EXCLUDE_TAGS="^((?!"$EXCLUDE_TAGS")(.*dev\d))+"
+echo "$EXCLUDE_TAGS"
+github_changelog_generator --future-release $NEW_RELEASE --exclude-tags-regex "$EXCLUDE_TAGS"
+```
+
+#### For production
+
+```bash
+github_changelog_generator --future-release $NEW_RELEASE --exclude-tags-regex 'dev\d$'
+```
+
+You can ignore warnings about missing PR commits like below as these relate to PRs to branches other than master:
+```
+Warning: PR 29 merge commit was not found in the release branch or tagged git history and no rebased SHA comment was found
+```
+
+
+### Export new release notes to variable
+
+```bash
+export RELEASE_NOTES=$(grep -Poz '(?<=\# Changelog\n\n)(.|\n)+?(?=\#\#)' CHANGELOG.md | tr '\0' '\n' )
+echo "$RELEASE_NOTES"  # Check the output and copy paste if neccessary
+```
+
+### Commit and push the changed files
+
+```bash
+git commit --all --verbose -m "Prepare $NEW_RELEASE"
+git push upstream release/$NEW_RELEASE -u
+```
+
+### Create a PR for the release, merge it, and re-fetch the master
+
+#### Create the PR
+```
+gh pr create --title "Prepare $NEW_RELEASE" --body "$RELEASE_NOTES" --label release-prep --base master
+```
+
+#### Merge the PR once the CI passes
+
+Create a squash commit and add the markdown from the PR description to the commit description.
+
+```bash
+gh pr merge --squash --body "$RELEASE_NOTES"
+```
+
+### Rebase local master
+
+```bash
+git checkout master
+git fetch upstream master
+git rebase upstream/master
+```
+
+### Create a release tag
+
+Note, add changelog release notes as the tag commit message so `gh release create --notes-from-tag` can be used to create a release draft.
+
+```bash
+git tag --annotate $NEW_RELEASE -m "$RELEASE_NOTES"
+git push upstream $NEW_RELEASE
+```
+
+### Create release
+
+#### Pre-releases
+
+```bash
+gh release create "$NEW_RELEASE" --verify-tag --notes-from-tag --title "$NEW_RELEASE" --draft --latest=false --prerelease
+
+```
+
+#### Production release
+
+```bash
+gh release create "$NEW_RELEASE" --verify-tag --notes-from-tag --title "$NEW_RELEASE" --draft --latest=true
+```
+
+### Manually publish the release
+
+Go to the linked URL, verify the contents, and click "release" button to trigger the release CI.
diff --git a/RELEASING.rst b/RELEASING.rst
diff --git a/docs/source/changelog.md b/docs/source/changelog.md
@@ -0,0 +1 @@
+:::{include} ../../CHANGELOG.md
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -4,7 +4,6 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 from __future__ import annotations
 
-import os
 from importlib.metadata import version as _version
 
 # -- Project information -----------------------------------------------------
@@ -24,7 +23,11 @@
     "sphinx.ext.coverage",
     "sphinx.ext.viewcode",
     "sphinx.ext.todo",
-    "sphinx_github_changelog",
+    "myst_parser",
+]
+
+myst_enable_extensions = [
+    "colon_fence",
 ]
 
 templates_path = ["_templates"]
@@ -36,4 +39,3 @@
 html_theme = "sphinx_rtd_theme"
 html_static_path = ["_static"]
 master_doc = "index"
-sphinx_github_changelog_token = os.environ.get("CHANGELOG_GITHUB_TOKEN")