Automate part of the release creation

Whenever a tag matching our versioning scheme is pushed, we automatically
create and upload a draft release.

.github/workflows/prepare_release.py

@@ -0,0 +1,85 @@
+#!/usr/bin/env python3
+
+import argparse
+import subprocess
+from pathlib import Path
+
+RELEASE_NOTES_TEMPLATE = """
+## Using Bzlmod (Recommended)
+
+Add to your `MODULE.bazel` file:
+
+```starlark
+bazel_dep(name = "depend_on_what_you_use", version = "{VERSION}")
+```
+
+## Using WORKSPACE (Legacy)
+
+Add to your `WORKSPACE` file:
+
+```starlark
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+http_archive(
+ name = "depend_on_what_you_use",
+ sha256 = "{SHA}",
+ strip_prefix = "depend_on_what_you_use-{VERSION}",
+ url = "https://github.com/martis42/depend_on_what_you_use/releases/download/{VERSION}/depend_on_what_you_use-{VERSION}.tar.gz",
+)
+
+load("@depend_on_what_you_use//:setup_step_1.bzl", dwyu_setup_step_1 = "setup_step_1")
+dwyu_setup_step_1()
+
+load("@depend_on_what_you_use//:setup_step_2.bzl", dwyu_setup_step_2 = "setup_step_2")
+dwyu_setup_step_2()
+```
+
+## Breaking Changes
+
+TBD
+
+## Noteworthy Changes
+
+TBD
+
+---
+"""
+
+
+def cli() -> argparse.Namespace:
+ parser = argparse.ArgumentParser()
+ parser.add_argument("--tag", metavar="VERSION", help="Tag for which to cut a release")
+ return parser.parse_args()
+
+
+def make_archive(tag: str) -> Path:
+ """
+ The prefix is the same as what GitHub generates for source archives.
+ Thus, users cans easily switch between the released archives and the source archives generated for reach commit.
+
+ If we wanted to omit files from the archive we could do this via a .gitignore file. But we don't do so for now.
+ https://github.com/bazel-contrib/rules-template/blob/4e541c8083645da37eb570c23e04dc65e1d6446c/.gitattributes
+ """
+ archive_format = "tar.gz"
+ archive_prefix = f"depend_on_what_you_use-{tag}"
+ archive = Path(f"depend_on_what_you_use-{tag}.{archive_format}")
+
+ subprocess.run(
+ ["git", "archive", f"--format={archive_format}", f"--prefix={archive_prefix}/", f"--output={archive}", tag],
+ check=True,
+ )
+
+ return archive
+
+
+def make_release_notes(archive: Path, tag: str) -> None:
+ checksum_process = subprocess.run(["sha256sum", archive], check=True, capture_output=True, text=True)
+ checksum = checksum_process.stdout.split(" ", 1)[0]
+ with Path("release_notes.txt").open(mode="w", encoding="utf-8") as release_notes:
+ release_notes.write(RELEASE_NOTES_TEMPLATE.format(SHA=checksum, VERSION=tag).strip())
+
+
+if __name__ == "__main__":
+ args = cli()
+ release_artifact = make_archive(args.tag)
+ make_release_notes(archive=release_artifact, tag=args.tag)

.github/workflows/release.yaml

@@ -0,0 +1,27 @@
+name: Release
+
+on:
+ push:
+ tags:
+ - "[0-9]+.[0-9]+.[0-9]+"
+
+permissions:
+ contents: write
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Prepare release
+ run: .github/workflows/prepare_release.py --tag ${GITHUB_REF_NAME}
+ - name: Draft release
+ uses: softprops/action-gh-release@v1
+ with:
+ draft: true
+ prerelease: true
+ generate_release_notes: true
+ body_path: release_notes.txt
+ fail_on_unmatched_files: true
+ files: depend_on_what_you_use-*.tar.gz

scripts/count_release_downloads.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python3
+
+"""
+From version 0.1.0 on we package a dedicated DWYU archive as part of each release for which we can get download
+statistics.
+"""
+
+# No benefit for using logging here
+# ruff: noqa: T201
+
+import json
+import subprocess
+
+token = input("Please provide an access token with permissions 'contents:read': ")
+
+cmd = [
+ "curl",
+ "-L",
+ "-H",
+ "Accept: application/vnd.github+json",
+ "-H",
+ f"Authorization: Bearer {token}",
+ "-H",
+ "X-GitHub-Api-Version: 2022-11-28",
+ "https://api.github.com/repos/martis42/depend_on_what_you_use/releases",
+]
+process = subprocess.run(cmd, check=True, capture_output=True, text=True)
+reply = json.loads(process.stdout.strip())
+
+for release in reply:
+ print(f"Release '{release['name']}'")
+ if "assets" not in release:
+ print(" No assets")
+ for asset in release["assets"]:
+ print(f" {asset['name']}: {asset['download_count']}")