[llvm][release] Add links to automatically built packages

[DavidSpickett]

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 revealed (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.

[DavidSpickett]

Putting this up now for quicker feedback, have not managed to run this yet.

[llvmbot]

@llvm/pr-subscribers-github-workflow

Author: David Spickett (DavidSpickett)

Changes

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 revealed (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.

---

Full diff: https://github.com/llvm/llvm-project/pull/147719.diff

2 Files Affected:

• (modified) .github/workflows/release-tasks.yml (+26)
• (modified) llvm/utils/release/github-upload-release.py (+43-1)

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@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)

[DavidSpickett]

This is like #147021 but the links are initially hidden and are revealed by a workflow step updating the release text.

[github-actions]

✅ With the latest revision this PR passed the Python code formatter.

[DavidSpickett]

I've tested this on my fork and it works. I did manually run the workflow, so there's a small chance it has permissions issues in reality.

The version of PyGitHub available in apt has some differences from the current one on GitHub so you'll notice some parameter names swapped like "name" and "title". They mean the same things.

[DavidSpickett]

Here's the release I tested on - https://github.com/DavidSpickett/llvm-project/releases/tag/vX.Y.Z-1, so you can see how it renders (I did not create the release using the script, so it still has {release} left in it).

Removing the lines leaves more empty lines than you'd usually want but Markdown will normalise it them to 1 blank line anyway. So I didn't go to any effort to tidy that up.