From 42f3232db9d142267cd54328726dc37adf8ddc76 Mon Sep 17 00:00:00 2001 From: Akuli Date: Fri, 25 Nov 2022 17:11:43 +0200 Subject: [PATCH] master --> main --- CONTRIBUTING.md | 8 ++++---- scripts/release.py | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c6064ecaa..e7610ec74 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -104,14 +104,14 @@ Other people shouldn't need them. as that won't show up correctly on GitHub's releases page. 2. Make a pull request of your changelog edits. Review carefully: changing the changelog afterwards is difficult, as the text gets copied into the releases page. -3. Merge the pull request and pull the merge commit to your local `master` branch. -4. Run `python3 scripts/release.py` from the `master` branch. +3. Merge the pull request and pull the merge commit to your local `main` branch. +4. Run `python3 scripts/release.py` from the `main` branch. The script pushes a tag named e.g. `v2022.08.28`, which triggers the parts of `.github/workflows/release-builds.yml` that have `if: startsWith(github.ref, 'refs/tags/v')` in them. They build and deploy docs, copy the changelog to the releases page, and so on. 5. Update `porcupine.wiki` if you added new features that are likely not obvious to users. -If you want, you can also do a release from a branch named `bugfix-release` instead of `master`. +If you want, you can also do a release from a branch named `bugfix-release` instead of `main`. This is useful if you fixed a bug that made Porcupine unusable for someone, -but the new features on `master` aren't ready for releasing yet. +but the new features on `main` aren't ready for releasing yet. diff --git a/scripts/release.py b/scripts/release.py index cfdeee4eb..0f7dcf1e4 100755 --- a/scripts/release.py +++ b/scripts/release.py @@ -26,7 +26,7 @@ def main(): # https://stackoverflow.com/a/1593487 branch = subprocess.check_output("git symbolic-ref --short HEAD", shell=True).decode().strip() - assert branch in ("master", "bugfix-release") + assert branch in ("main", "bugfix-release") # If this fails you have uncommitted changes for line in subprocess.check_output("git status --porcelain", shell=True).splitlines():