Changes between Version 3 and Version 4 of ReleaseScript

Timestamp:

May 7, 2025, 4:16:49 PM (4 months ago)

Author:

Natalia Bidart

Comment:

Adjusted and cleaned up release script to use env var for PGP key, url, and artifacts folder.

ReleaseScript

@@ -1 @@
-This Python script helps release a new version of Django. You should run this script from the Django repo root, having checked out the stable branch that you wish to release.
+This Python script helps release a new version of Django. You should run this script from the Django repo root, having checked out the stable branch that you wish to release. Common usage:
+
+{{{
+$ PGP_KEY_ID=1112223334445556 PGP_KEY_URL=https://github.com/octopus.gpg DEST_FOLDER=~/django/releases do_django_release.py
+}}}
+
 {{{#!python
 #! /usr/bin/env python
@@ -9 +14 @@
 import subprocess
 from datetime import date
-from io import StringIO
-
-PGP_KEY_ID = "2EE82A8D9470983E"
-PGP_EMAIL = "124304+nessita@users.noreply.github.com"
-PATH_TO_BINARIES = "/home/nessita/fellowship/releases"
-CHECKSUM_DEST_DIR = "/home/nessita/fellowship/releases/checksums"
-GITHUB_USERNAME = "nessita"
-
-checksum_file_text = """This file contains MD5, SHA1, and SHA256 checksums for the source-code
-tarball and wheel files of Django {django_version}, released {release_date}.
+
+PGP_KEY_ID = os.getenv("PGP_KEY_ID", "")
+PGP_KEY_URL = os.getenv("PGP_KEY_URL", "")
+PGP_EMAIL = os.getenv("PGP_EMAIL", "")
+DEST_FOLDER = os.path.expanduser(os.getenv("DEST_FOLDER", ""))
+
+assert (
+    PGP_KEY_ID
+), "Missing PGP_KEY_ID: Set this env var to your PGP key ID (used for signing)."
+assert (
+    PGP_KEY_URL
+), "Missing PGP_KEY_URL: Set this env var to your PGP public key URL (for fetching)."
+assert DEST_FOLDER and os.path.exists(
+    DEST_FOLDER
+), "Missing DEST_FOLDER: Set this env var to the local path to place the artifacts."
+
+
+checksum_file_text = """This file contains MD5, SHA1, and SHA256 checksums for the
+source-code tarball and wheel files of Django {django_version}, released {release_date}.
 
 To use this file, you will need a working install of PGP or other
@@ -31 +45 @@
 or via the GitHub API:
 
-    curl https://github.com/{github_username}.gpg | gpg --import -
+    curl {pgp_key_url} | gpg --import -
 
 Once the key is imported, verify this file:
@@ -67 +81 @@
 """
 
-PATH_TO_DJANGO = os.path.abspath(os.path.curdir)
 
 def build_artifacts():
@@ -83 +96 @@
 subprocess.call(["git", "clean", "-fdx"])
 
-dist_path = os.path.join(PATH_TO_DJANGO, "dist/")
-
-## Build release files.
+django_repo_path = os.path.abspath(os.path.curdir)
+dist_path = os.path.join(django_repo_path, "dist/")
+
+# Build release files.
 build_artifacts()
 release_files = os.listdir(dist_path)
@@ -101 +115 @@
 django_version = wheel_name.split("-")[1]
 django_major_version = ".".join(django_version.split(".")[:2])
+
+artifacts_path = os.path.join(os.path.expanduser(DEST_FOLDER), django_version)
+os.makedirs(artifacts_path, exist_ok=True)
+
 # Chop alpha/beta/rc suffix
 match = re.search("[abrc]", django_major_version)
@@ -112 +130 @@
     pgp_key_id=PGP_KEY_ID,
     django_version=django_version,
-    github_username=GITHUB_USERNAME,
+    pgp_key_url=PGP_KEY_URL,
     checksum_file_name=checksum_file_name,
     wheel_name=wheel_name,
@@ -132 +150 @@
 # Create the checksum file
 checksum_file_text = checksum_file_text.format(**checksum_file_kwargs)
-os.makedirs(CHECKSUM_DEST_DIR, exist_ok=True)
-checksum_file_path = os.path.join(CHECKSUM_DEST_DIR, checksum_file_name)
+checksum_file_path = os.path.join(artifacts_path, checksum_file_name)
 with open(checksum_file_path, "wb") as f:
     f.write(checksum_file_text.encode("ascii"))
@@ -166 +183 @@
 
 # Sign the checksum file, this may prompt for a passphrase.
-print(f"gpg --clearsign -u {PGP_EMAIL} --digest-algo SHA256 {checksum_file_path}")
+pgp_email = f"-u {PGP_EMAIL} " if PGP_EMAIL else ""
+print(f"gpg --clearsign {pgp_email}--digest-algo SHA256 {checksum_file_path}")
 # Create, verify and push tag
 print(f'git tag --sign --message="Tag {django_version}" {django_version}')
@@ -172 +190 @@
 
 # Copy binaries outside the current repo tree to avoid lossing them.
-path_to_binaries = os.path.join(PATH_TO_BINARIES, django_version)
-os.makedirs(path_to_binaries, exist_ok=True)
-subprocess.run(["cp", "-r", dist_path, path_to_binaries])
+subprocess.run(["cp", "-r", dist_path, artifacts_path])
 
 # Make the binaries available to the world
@@ -183 +199 @@
 # Upload the checksum file and release artifacts to the djangoproject admin.
 print(
-    "\n==> ACTION Add a new Release entry in https://www.djangoproject.com/admin/releases/release/add/:"
-)
-print(
-    f"""* Version: {django_version}
-* Is active: False
-* Release date: {release_date}
-* End of life date: None"""
-)
-
-print(
-    "\n==> ACTION Add tarball, wheel, and checksum files to the newly created Release entry:"
-)
-print(
-    f"""* Tarball and wheel from {path_to_binaries}
-* Signed checksum {checksum_file_path}.asc"""
+    "\n==> ACTION Add a new Release entry in "
+    "https://www.djangoproject.com/admin/releases/release/add/:"
+)
+print(
+    f"* Version: {django_version}\n"
+    "* Is active: False\n"
+    f"* Release date: {release_date}\n"
+    "* End of life date: None"
+)
+
+print("\n==> ACTION Add tarball, wheel, and checksum files to the Release entry:")
+print(
+    f"* Tarball and wheel from {artifacts_path}\n"
+    f"* Signed checksum {checksum_file_path}.asc"
 )
 
@@ -208 +223 @@
 # Upload to PyPI.
 print("\n==> ACTION Upload to PyPI:")
-print(f"cd {path_to_binaries}")
+print(f"cd {artifacts_path}")
 print("source ~/.virtualenvs/djangorelease/bin/activate")
 print("pip install -U pip twine")