[llvm] [llvm][release] Add links to automatically built packages on release pages (PR #147719)
David Spickett via llvm-commits
llvm-commits at lists.llvm.org
Wed Jul 9 06:23:49 PDT 2025
https://github.com/DavidSpickett updated https://github.com/llvm/llvm-project/pull/147719
>From 3cc21448b7a31cab999ec48e479f6187692e7245 Mon Sep 17 00:00:00 2001
From: David Spickett <david.spickett at linaro.org>
Date: Fri, 4 Jul 2025 08:54:32 +0000
Subject: [PATCH 1/2] [llvm][release] Add links to automatically built packages
on release page
This adds links to the release packages that are automatically built
using GitHub, so that users of those platforms can find them more
easily.
The approach taken:
* "LLVM x.y.z Release" becomes the title for this links section.
* No hand built files are linked to because we can't be sure
when or if they will appear. It's better that users check the
full file list if they need those.
* This means no Windows links, but I've specifically mentioned
Windows just below the links to mitigate this.
* I have tried to use the vendor names for the architectures,
that casual users would recognise.
* Their signature file is linked as well. I expect most will ignore
this but better to show it to remind people it exists.
* I called it "signature" as a generic term to cover the .jsonl
and .sig files, but we're not linking to any .sig files yet.
* Links are initially commented out and there is a placeholder string.
Once all binaries are built, the placeholder is removed and the
download links revelealed (we wait for them all so we don't
have many jobs racing to update the release text).
I considered generating this using a lot of templates, but
considering the small number of links and how useful it is to
see the layout in the Python file, I prefer writing it out.
---
.github/workflows/release-tasks.yml | 26 ++++++++++++
llvm/utils/release/github-upload-release.py | 44 ++++++++++++++++++++-
2 files changed, 69 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/release-tasks.yml b/.github/workflows/release-tasks.yml
index d55098345d89e..98e3f48391fa6 100644
--- a/.github/workflows/release-tasks.yml
+++ b/.github/workflows/release-tasks.yml
@@ -111,3 +111,29 @@ jobs:
# Called workflows don't have access to secrets by default, so we need to explicitly pass secrets that we use.
secrets:
RELEASE_TASKS_USER_TOKEN: ${{ secrets.RELEASE_TASKS_USER_TOKEN }}
+
+ uncomment-download-links:
+ name: Uncomment download links
+ runs-on: ubuntu-24.04
+ permissions:
+ contents: write # For updating the release message.
+ needs:
+ - validate-tag
+ - release-create
+ - release-binaries
+
+ steps:
+ - name: Install Dependencies
+ run: |
+ sudo apt-get update
+ sudo apt-get install python3-github
+
+ - name: Checkout LLVM
+ uses: actions/checkout at b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+ - name: Uncomment Download Links
+ env:
+ GITHUB_TOKEN: ${{ github.token }}
+ USER_TOKEN: ${{ secrets.RELEASE_TASKS_USER_TOKEN }}
+ run: |
+ ./llvm/utils/release/./github-upload-release.py --token "$GITHUB_TOKEN" --release ${{ needs.validate-tag.outputs.release-version }} --user ${{ github.actor }} --user-token "$USER_TOKEN" uncomment_download_links
diff --git a/llvm/utils/release/github-upload-release.py b/llvm/utils/release/github-upload-release.py
index e9591b00e2b5a..f73b9927c9da9 100755
--- a/llvm/utils/release/github-upload-release.py
+++ b/llvm/utils/release/github-upload-release.py
@@ -45,9 +45,26 @@ def create_release(repo, release, tag=None, name=None, message=None):
# Note that these lines are not length limited because if we do so, GitHub
# assumes that should be how it is laid out on the page. We want GitHub to
# do the reflowing for us instead.
+ #
+ # Once all binaries are built, the HTML comments in the text below will be
+ # used to swap the placeholder text with the now valid download links.
message = dedent(
"""\
-LLVM {release} Release
+## LLVM {release} Release
+
+<!-- DOWNLOAD_LINKS_BEGIN
+**Linux:**
+* [x86_64](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-Linux-X64.tar.xz) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-Linux-X64.tar.xz.jsonl))
+* [Arm64](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-Linux-ARM64.tar.xz) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-Linux-ARM64.tar.xz.jsonl))
+
+**macOS:**
+* [Apple Silicon](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-macOS-ARM64.tar.xz) (ARM64) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-macOS-ARM64.tar.xz.jsonl))
+* [Intel](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-macOS-X64.tar.xz) (x86-64) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-macOS-X64.tar.xz.jsonl))
+DOWNLOAD_LINKS_END -->
+
+Download links for Linux and macOS will appear above once builds complete. <!-- DOWNLOAD_LINKS_PLACEHOLDER -->
+
+For Windows, and any other variants of platform and architecture, check the full list of release packages at the bottom of this release page.
## Package Types
@@ -95,6 +112,29 @@ def upload_files(repo, release, files):
print("Done")
+def uncomment_download_links(repo, release):
+ release = repo.get_release("llvmorg-{}".format(release))
+
+ new_message = []
+ to_remove = [
+ "DOWNLOAD_LINKS_BEGIN",
+ "DOWNLOAD_LINKS_END",
+ "DOWNLOAD_LINKS_PLACEHOLDER",
+ ]
+ for line in release.message.splitlines():
+ for comment in to_remove:
+ if comment in line:
+ continue
+ new_message.append(line)
+
+ release.update_release(
+ name=release.name,
+ message="\n".join(new_message),
+ draft=release.draft,
+ prerelease=release.prerelease,
+ )
+
+
parser = argparse.ArgumentParser()
parser.add_argument(
"command", type=str, choices=["create", "upload", "check-permissions"]
@@ -137,3 +177,5 @@ def upload_files(repo, release, files):
create_release(llvm_repo, args.release)
if args.command == "upload":
upload_files(llvm_repo, args.release, args.files)
+if args.commands == "uncomment_download_links":
+ uncomment_download_links(llvm_repo, args.release)
>From 706738c81999f2b8bd1d1a87e9c120bf97eefcfa Mon Sep 17 00:00:00 2001
From: David Spickett <david.spickett at linaro.org>
Date: Wed, 9 Jul 2025 13:21:06 +0000
Subject: [PATCH 2/2] sparse checkout script
---
.github/workflows/release-tasks.yml | 3 +++
1 file changed, 3 insertions(+)
diff --git a/.github/workflows/release-tasks.yml b/.github/workflows/release-tasks.yml
index 98e3f48391fa6..6228ec887b61f 100644
--- a/.github/workflows/release-tasks.yml
+++ b/.github/workflows/release-tasks.yml
@@ -130,6 +130,9 @@ jobs:
- name: Checkout LLVM
uses: actions/checkout at b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+ with:
+ sparse-checkout: llvm/utils/release/github-upload-release.py
+ sparse-checkout-cone-mode: false
- name: Uncomment Download Links
env:
More information about the llvm-commits
mailing list