[llvm][release] Reveal download links based on uploaded assets #167688

DavidSpickett · 2025-11-12T13:25:31Z

For the 21.x release, download links were supposed to be revealed once all the release builds had completed. In reality, MacOS never had a successful build so I had to hand edit the release messages.

This PR fixes this by focusing instead on what is in the release assets.

Links are now built from a format string, with the linked files being format arguments for that string. This is a balance between ease of editing the format, and having the file names for use later.

(I tried regex-ing file names out of the final links, which can work but is error prone and will be hard to debug in production)

Here's an example line:

  <!-- LINUX_X86 * [Linux x86_64](https://github.com/llvm/llvm-project/releases/download/llvmorg-vX.Y.Z-1/LLVM-vX.Y.Z-1-Linux-X64.tar.xz) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-vX.Y.Z-1/LLVM-vX.Y.Z-1-Linux-X64.tar.xz.jsonl)) -->

uncomment_download_links now looks at the release assets to decide whether to reveal a given link line. If all the files that line links to are present, it can be revealed.

This means we can still run this at the end of release-tasks.yml, where it will be atomic.

Initially I was going to accumulate the statuses from the release build matrix job, but this does not seem to be possible (https://github.com/orgs/community/discussions/17245).

Workarounds for this often include uploading artifacts from each job, which for us, is the same as checking the release's assets.

This process is done for all assets we would like to link to, not just the ones currently built in GitHub.

So if some become automatically built, they will "just work". If we want to hand edit the links in, that's still an option because the full links are in the release message, but hidden from view.

As we are looking for <!-- SOME_TAG, the script can be run multiple times on the same release and it will not try to edit anything already revealed.

As it's possible no link lines have all their files, the text immediately after the links has been updated to make sense when there are no links.

For the 21.x release, download links were supposed to be revealed once all the release builds had completed. In reality, MacOS never had a succesfull build so I had to hand edit the release messages. This PR fixes this by focusing instead on what is in the release assets. 1. Links are now built from a format string, with the linked files being format arguments for that string. This is a balance between ease of editing the format, and having the file names for use later. (I tried regex-ing file names out of the final links, which can work but is error prone and will be hard to debug in production) 2. uncomment_download_links now looks at the release assets to decide whether to reveal a given link line. If all the files that line links to are present, it can be revealed. This means we can still run this at the end of release-tasks.yml, where it will be atomic. Intially I was going to accumulate the statuses from the release build matrix job, but this does not seem to be possible (https://github.com/orgs/community/discussions/17245). Workarounds for this often include uploading artefacts from each job, which is for us, the same as checking the release's assets. This process is done for all assets we would like to link to, not just the ones currently built in GitHub. So if some become automatically built, they will "just work". If we want to hand edit the links in, that's still an option because the full links are in the release message, but hidden from view. As we are looking for "<!-- SOME_TAG", the script can be run multiple times on the same release and it will not try to edit anything already revealed. As it's possible no link lines have all their files, the text immediately after the links has been updated to make sense when there are no links.

DavidSpickett · 2025-11-12T13:28:49Z

llvm/utils/release/github-upload-release.py

+                                "  These files are not present:",
+                                files.difference(release_assets),
+                            )
+                            print("  Link line will remain hidden.")


I'm leaving the prints in for logging purposes, they're not leftover debug prints.

Some example output:

Found release assets: {'clang+llvm-vX.Y.Z-1-aarch64-pc-windows-msvc.tar.xz', 'LLVM-vX.Y.Z-1-Linux-X64.tar.xz.jsonl', 'LLVM-vX.Y.Z-1-Linux-X64.tar.xz'} Found link line "LINUX_X86": Files required: {'LLVM-vX.Y.Z-1-Linux-X64.tar.xz.jsonl', 'LLVM-vX.Y.Z-1-Linux-X64.tar.xz'} All files present, revealing link line. <...> Found link line "WINDOWS_ARM64": Files required: {'clang+llvm-vX.Y.Z-1-aarch64-pc-windows-msvc.tar.xz.sig', 'LLVM-vX.Y.Z-1-woa64.exe', 'LLVM-vX.Y.Z-1-woa64.exe.sig', 'clang+llvm-vX.Y.Z-1-aarch64-pc-windows-msvc.tar.xz'} These files are not present: {'clang+llvm-vX.Y.Z-1-aarch64-pc-windows-msvc.tar.xz.sig', 'LLVM-vX.Y.Z-1-woa64.exe', 'LLVM-vX.Y.Z-1-woa64.exe.sig'} Link line will remain hidden.

Either this will never go wrong and no one will see any of it, or, more likely, it will, and this will be helpful to have in the log.

DavidSpickett · 2025-11-12T13:32:10Z

The script is currently run from here:

llvm-project/.github/workflows/release-tasks.yml

Line 118 in 7838dbe

uncomment-download-links:

Right after the release binaries jobs have finished (with whatever status).

DavidSpickett · 2025-11-12T13:39:37Z

Below is a set of generated links for a release vX.Y.Z-1. So you can see that the format is the same as before. If you were to manually edit the release message, you'd have the full link content there. No need to re-run the script.

Linux x86_64 (signature)
Linux Arm64 (signature)
Linux Armv7-a (signature)
macOS Apple Silicon (ARM64) (signature)
macOS Intel (x86-64) (signature)
Windows x64 (64-bit): installer (signature), archive (signature)
Windows x86 (32-bit): installer (signature)
Windows on Arm (ARM64): installer (signature), archive (signature)

llvmbot · 2025-11-19T10:07:30Z

@llvm/pr-subscribers-github-workflow

Author: David Spickett (DavidSpickett)

Changes

For the 21.x release, download links were supposed to be revealed once all the release builds had completed. In reality, MacOS never had a successful build so I had to hand edit the release messages.

This PR fixes this by focusing instead on what is in the release assets.

Links are now built from a format string, with the linked files being format arguments for that string. This is a balance between ease of editing the format, and having the file names for use later.

(I tried regex-ing file names out of the final links, which can work but is error prone and will be hard to debug in production)

Here's an example line:

  &lt;!-- LINUX_X86 * [Linux x86_64](https://github.com/llvm/llvm-project/releases/download/llvmorg-vX.Y.Z-1/LLVM-vX.Y.Z-1-Linux-X64.tar.xz) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-vX.Y.Z-1/LLVM-vX.Y.Z-1-Linux-X64.tar.xz.jsonl)) --&gt;

uncomment_download_links now looks at the release assets to decide whether to reveal a given link line. If all the files that line links to are present, it can be revealed.

This means we can still run this at the end of release-tasks.yml, where it will be atomic.

Initially I was going to accumulate the statuses from the release build matrix job, but this does not seem to be possible (https://github.com/orgs/community/discussions/17245).

Workarounds for this often include uploading artifacts from each job, which for us, is the same as checking the release's assets.

This process is done for all assets we would like to link to, not just the ones currently built in GitHub.

So if some become automatically built, they will "just work". If we want to hand edit the links in, that's still an option because the full links are in the release message, but hidden from view.

As we are looking for <!-- SOME_TAG, the script can be run multiple times on the same release and it will not try to edit anything already revealed.

As it's possible no link lines have all their files, the text immediately after the links has been updated to make sense when there are no links.

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

2 Files Affected:

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

diff --git a/.github/workflows/release-tasks.yml b/.github/workflows/release-tasks.yml
index d4c2a55fcc9d7..df6b04803bbf5 100644
--- a/.github/workflows/release-tasks.yml
+++ b/.github/workflows/release-tasks.yml
@@ -120,9 +120,8 @@ jobs:
     runs-on: ubuntu-24.04
     permissions:
       contents: write # For updating the release message.
+    if: always()
     needs:
-      - validate-tag
-      - release-create
       - release-binaries
 
     steps:
diff --git a/llvm/utils/release/github-upload-release.py b/llvm/utils/release/github-upload-release.py
index d58bb544e17dd..958eba094dbde 100755
--- a/llvm/utils/release/github-upload-release.py
+++ b/llvm/utils/release/github-upload-release.py
@@ -34,6 +34,103 @@
 from textwrap import dedent
 
 
+# This is a tuple of sections of download links. Each section then contains
+# an entry for each line in that section. Each line entry contains:
+# * A unique tag to go in "<!-- <tag>" so we can find it later in the release
+#   message.
+# * A format string for the line's content.
+# * Filenames to substitute into the format string. Before substitution into
+#   the format string, file names will have the base download URL prepended to
+#   them and 'release' replaced with the release version.
+#
+# Between each set of links, an empty line will be added.
+#
+# This data is used to generate the links for the release message, and by
+# uncomment_download_links to verify whether for any given link line, all files
+# linked to are present in the release's assets.
+release_links = (
+    (
+        (
+            "LINUX_X86",
+            "* [Linux x86_64]({0}) ([signature]({1}))",
+            "LLVM-{release}-Linux-X64.tar.xz",
+            "LLVM-{release}-Linux-X64.tar.xz.jsonl",
+        ),
+        (
+            "LINUX_ARM64",
+            "* [Linux Arm64]({0}) ([signature]({1}))",
+            "LLVM-{release}-Linux-ARM64.tar.xz",
+            "LLVM-{release}-Linux-ARM64.tar.xz.jsonl",
+        ),
+        (
+            "LINUX_ARMV7A",
+            "* [Linux Armv7-a]({0}) ([signature]({1}))",
+            "clang+llvm-{release}-armv7a-linux-gnueabihf.tar.gz",
+            "clang+llvm-{release}-armv7a-linux-gnueabihf.tar.gz.sig",
+        ),
+    ),
+    (
+        (
+            "MACOS_ARM64",
+            "* [macOS Apple Silicon]({0}) (ARM64) ([signature]({1}))",
+            "LLVM-{release}-macOS-ARM64.tar.xz",
+            "LLVM-{release}-macOS-ARM64.tar.xz.jsonl",
+        ),
+        (
+            "MACOS_X86",
+            "* [macOS Intel]({0}) (x86-64) ([signature]({1}))",
+            "LLVM-{release}-macOS-X64.tar.xz",
+            "LLVM-{release}-macOS-X64.tar.xz.jsonl",
+        ),
+    ),
+    (
+        (
+            "WINDOWS_X64",
+            "* Windows x64 (64-bit): [installer]({0}) ([signature]({1})), [archive]({2}) ([signature]({3}))",
+            "LLVM-{release}-win64.exe",
+            "LLVM-{release}-win64.exe.sig",
+            "clang+llvm-{release}-x86_64-pc-windows-msvc.tar.xz",
+            "clang+llvm-{release}-x86_64-pc-windows-msvc.tar.xz.sig",
+        ),
+        (
+            "WINDOWS_X86",
+            "* Windows x86 (32-bit): [installer]({0}) ([signature]({1}))",
+            "LLVM-{release}-win32.exe",
+            "LLVM-{release}-win32.exe.sig",
+        ),
+        (
+            "WINDOWS_ARM64",
+            "* Windows on Arm (ARM64): [installer]({0}) ([signature]({1})), [archive]({2}) ([signature]({3}))",
+            "LLVM-{release}-woa64.exe",
+            "LLVM-{release}-woa64.exe.sig",
+            "clang+llvm-{release}-aarch64-pc-windows-msvc.tar.xz",
+            "clang+llvm-{release}-aarch64-pc-windows-msvc.tar.xz.sig",
+        ),
+    ),
+)
+
+
+def generate_download_links(release):
+    base_url = (
+        f"https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/"
+    )
+    markdown_lines = []
+
+    for section in release_links:
+        for line in section:
+            comment_tag, format_string, *files = line
+            markdown_line = f"<!-- {comment_tag} "
+            files = [base_url + f.format(release=release) for f in files]
+            markdown_line += format_string.format(*files)
+            markdown_line += " -->"
+            markdown_lines.append(markdown_line)
+
+        # Blank line between each section.
+        markdown_lines.append("")
+
+    return "\n".join(markdown_lines)
+
+
 def create_release(repo, release, tag=None, name=None, message=None):
     if not tag:
         tag = "llvmorg-{}".format(release)
@@ -45,33 +142,15 @@ 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 the atuomatic binary builds have completed, the HTML comments
-        # with UPPERCASE markers in them will be removed to reveal the download
-        # links later. Other lines are surrounded in <!-- --> for release uploaders
-        # to manually uncomment when they upload that package.
+        download_links = generate_download_links(release)
         message = dedent(
-            """\
+            f"""\
 ## LLVM {release} Release
 
-<!-- AUTOMATIC_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))
-* [Linux 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))
-AUTOMATIC_DOWNLOAD_LINKS_END -->
-<!-- * [Linux Armv7-a](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/clang+llvm-{release}-armv7a-linux-gnueabihf.tar.gz) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/clang+llvm-{release}-armv7a-linux-gnueabihf.tar.gz.sig)) -->
-
-<!-- AUTOMATIC_DOWNLOAD_LINKS_BEGIN
-* [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))
-* [macOS 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))
-AUTOMATIC_DOWNLOAD_LINKS_END -->
-
-<!-- * Windows x64 (64-bit): [installer](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-win64.exe) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-win64.exe.sig)), [archive](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/clang+llvm-{release}-x86_64-pc-windows-msvc.tar.xz) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/clang+llvm-{release}-x86_64-pc-windows-msvc.tar.xz.sig)) -->
-<!-- * Windows x86 (32-bit): [installer](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-win32.exe) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-win32.exe.sig)) -->
-<!-- * Windows on Arm (ARM64): [installer](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-woa64.exe) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/LLVM-{release}-woa64.exe.sig)), [archive](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/clang+llvm-{release}-aarch64-pc-windows-msvc.tar.xz) ([signature](https://github.com/llvm/llvm-project/releases/download/llvmorg-{release}/clang+llvm-{release}-aarch64-pc-windows-msvc.tar.xz.sig)) -->
+{download_links}
+Download links for common platforms will appear above, if they are available. Check the full list of release packages at the bottom of this release page if you do not find a link above.
 
-Download links will appear here once builds have completed. <!-- AUTOMATIC_DOWNLOAD_LINKS_PLACEHOLDER -->
-
-For any other variants of platform and architecture, check the full list of release packages at the bottom of this release page. If you do not find a release package for your platform, you may be able to find a community built package on the LLVM Discourse forum thread for this release. Remember that these are built by volunteers and may not always be available. If you rely on a platform or configuration that is not one of the defaults, we suggest you use the binaries that your platform provides, or build your own release packages.
+If you do not find a release package for your platform, you may be able to find a community built package on the LLVM Discourse forum thread for this release. Remember that these are built by volunteers and may not always be available. If you rely on a platform or configuration that is not one of the defaults, we suggest you use the binaries that your platform provides, or build your own release packages.
 
 ## Package Types
 
@@ -100,7 +179,7 @@ def create_release(repo, release, tag=None, name=None, message=None):
 $ gh attestation verify --repo llvm/llvm-project <package file name> --bundle <package file name>.jsonl
 (using attestation file on disk)
 ```"""
-        ).format(release=release)
+        )
 
     prerelease = True if "rc" in release else False
 
@@ -115,28 +194,48 @@ def upload_files(repo, release, files):
         print("Done")
 
 
-def uncomment_download_links(repo, release):
-    release = repo.get_release("llvmorg-{}".format(release))
+def uncomment_download_links(repo, release_version):
+    release = repo.get_release("llvmorg-{}".format(release_version))
+
+    # At this point any automatic builds have finished and if
+    # they succeeded, uploaded files to the release assets.
+    release_assets = set([a.name for a in release.assets])
+    print("Found release assets: ", release_assets)
 
     new_message = []
-    to_remove = [
-        "AUTOMATIC_DOWNLOAD_LINKS_BEGIN",
-        "AUTOMATIC_DOWNLOAD_LINKS_END",
-        "AUTOMATIC_DOWNLOAD_LINKS_PLACEHOLDER",
-    ]
+    modified = False
     for line in release.body.splitlines():
-        for comment in to_remove:
-            if comment in line:
-                break
-        else:
-            new_message.append(line)
-
-    release.update_release(
-        name=release.title,
-        message="\n".join(new_message),
-        draft=release.draft,
-        prerelease=release.prerelease,
-    )
+        # All hidden download links are of the form:
+        # <!-- <some unique tag> <markdown content> -->
+        if line.startswith("<!--"):
+            for section in release_links:
+                for comment_tag, _, *files in section:
+                    if comment_tag in line:
+                        print(f'Found link line "{comment_tag}":')
+                        files = set([f.format(release=release_version) for f in files])
+                        print("  Files required:", files)
+                        if files.issubset(release_assets):
+                            print("  All files present, revealing link line.")
+                            line.replace("<!--", "").replace(comment_tag, "").replace(
+                                "-->", ""
+                            ).strip()
+                            modified = True
+                        else:
+                            print(
+                                "  These files are not present:",
+                                files.difference(release_assets),
+                            )
+                            print("  Link line will remain hidden.")
+
+        new_message.append(line)
+
+    if modified:
+        release.update_release(
+            name=release.title,
+            message="\n".join(new_message),
+            draft=release.draft,
+            prerelease=release.prerelease,
+        )
 
 
 parser = argparse.ArgumentParser()

github-actions · 2025-11-19T10:53:52Z

🐧 Linux x64 Test Results

186420 tests passed
4867 tests skipped

c-rhodes

thanks for patch, seems like a good change. I've left a few minor comments, but otherwise LGTM cheers.

llvm/utils/release/github-upload-release.py

DavidSpickett requested review from c-rhodes, dyung, tru and tstellar November 12, 2025 13:25

DavidSpickett commented Nov 12, 2025

View reviewed changes

DavidSpickett mentioned this pull request Nov 12, 2025

github-upload-release broken by the recent changes to the release text / download links #153154

Closed

DavidSpickett added 2 commits November 13, 2025 09:31

fix macos intel link syntax

8e9c799

Must run even if part of release-binaries fails

dd711a9

llvmbot added the github:workflow label Nov 19, 2025

On second thought, always run but not if someone cancelled the pipeline.

47eca39

c-rhodes approved these changes Nov 19, 2025

View reviewed changes

DavidSpickett added 7 commits November 20, 2025 13:44

use f string

83a4c5c

early continue to reduce indentation

2e738a7

revise message

4b9ee14

fix

51f3bf8

files as a list

7d57b8a

format

bd09d55

tuple for files

5d6ba9b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[llvm][release] Reveal download links based on uploaded assets #167688

[llvm][release] Reveal download links based on uploaded assets #167688

DavidSpickett commented Nov 12, 2025 •

edited

Loading

Uh oh!

DavidSpickett Nov 12, 2025

Uh oh!

DavidSpickett commented Nov 12, 2025

Uh oh!

DavidSpickett commented Nov 12, 2025

Uh oh!

llvmbot commented Nov 19, 2025

Uh oh!

github-actions bot commented Nov 19, 2025 •

edited

Loading

Uh oh!

c-rhodes left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[llvm][release] Reveal download links based on uploaded assets #167688

Are you sure you want to change the base?

[llvm][release] Reveal download links based on uploaded assets #167688

Conversation

DavidSpickett commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DavidSpickett Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

DavidSpickett commented Nov 12, 2025

Uh oh!

DavidSpickett commented Nov 12, 2025

Uh oh!

llvmbot commented Nov 19, 2025

Uh oh!

github-actions bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🐧 Linux x64 Test Results

Uh oh!

c-rhodes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

DavidSpickett commented Nov 12, 2025 •

edited

Loading

github-actions bot commented Nov 19, 2025 •

edited

Loading