Applied-Software/ghostty
5
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2025-07-17 17:26:09 +03:00
Code Issues Packages Projects Releases Wiki Activity

macOS: add link to release notes on appcast (#5184)

Browse Source 
Resolves #4730

I opted to link directly to the release notes of the updated version in
the `<description>` body, i.e. in the future it would link directly
v1.0.2's release notes at
https://ghostty.org/docs/install/release-notes/1-0-2. This thereby
implements the second option mentioned in the issue. It wasn't that much
harder than the third option, but if there's any particular reason _not
to_ link directly to a version's changelog page, I'll be more than happy
to modify this PR and implement the third option instead - in any case,
I had opened https://github.com/ghostty-org/website/pull/277 so that
https://ghostty.org/docs/install/release-notes is a valid page.

I also wrapped the current text `<![CDATA[ ... ]]>` just in case, as I
noticed this is a pretty standard practice in other apps that use
`<description>` to embed their release notes when using Sparkle -
[Sparkle's
documentation](https://sparkle-project.org/documentation/publishing/#embedded-release-notes)
says to do this so you can use unescaped HTML.
This commit is contained in:
Mitchell Hashimoto
2025-01-29 14:38:18 -08:00
committed by GitHub
parent 09ccda4d28 018a888578
commit c33b82c634
2 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
dist/macos/update_appcast_tag.py vendored
View File

@ -21,6 +21,7 @@ from datetime import datetime, timezone
now = datetime.now(timezone.utc) now = datetime.now(timezone.utc)
version = os.environ["GHOSTTY_VERSION"] version = os.environ["GHOSTTY_VERSION"]
version_dash = version.replace('.', '-')
build = os.environ["GHOSTTY_BUILD"] build = os.environ["GHOSTTY_BUILD"]
commit = os.environ["GHOSTTY_COMMIT"] commit = os.environ["GHOSTTY_COMMIT"]
commit_long = os.environ["GHOSTTY_COMMIT_LONG"] commit_long = os.environ["GHOSTTY_COMMIT_LONG"]
@ -82,18 +83,20 @@ elem = ET.SubElement(item, "sparkle:shortVersionString")
elem.text = f"{version}" elem.text = f"{version}"
elem = ET.SubElement(item, "sparkle:minimumSystemVersion") elem = ET.SubElement(item, "sparkle:minimumSystemVersion")
elem.text = "13.0.0" elem.text = "13.0.0"
elem = ET.SubElement(item, "sparkle:fullReleaseNotesLink")
elem.text = f"https://ghostty.org/docs/install/release-notes/{version_dash}"
elem = ET.SubElement(item, "description") elem = ET.SubElement(item, "description")
elem.text = f""" elem.text = f"""
<h1>Ghostty v{version}</h1> <![CDATA[<h1>Ghostty v{version}</h1>
<p> <p>
This release was built from commit <code><a href="{repo}/commits/{commit_long}">{commit}</a></code> This release was built from commit <code><a href="{repo}/commits/{commit_long}">{commit}</a></code>
on {now.strftime('%Y-%m-%d')}. on {now.strftime('%Y-%m-%d')}.
</p> </p>
<p> <p>
We don't currently generate release notes for auto-updates. We don't currently generate release notes for auto-updates.
You can view the complete changelog and release notes on You can view the complete changelog and release notes
the <a href="https://ghostty.org">Ghostty website</a>. at <a href="https://ghostty.org/docs/install/release-notes/{version_dash}">ghostty.org/docs/install/release-notes/{version_dash}</a>.
</p> </p>]]>
""" """
elem = ET.SubElement(item, "enclosure") elem = ET.SubElement(item, "enclosure")
elem.set("url", f"https://release.files.ghostty.org/{version}/Ghostty.dmg") elem.set("url", f"https://release.files.ghostty.org/{version}/Ghostty.dmg")

4
dist/macos/update_appcast_tip.py vendored
View File

@ -83,7 +83,7 @@ elem = ET.SubElement(item, "sparkle:minimumSystemVersion")
elem.text = "13.0.0" elem.text = "13.0.0"
elem = ET.SubElement(item, "description") elem = ET.SubElement(item, "description")
elem.text = f""" elem.text = f"""
<p> <![CDATA[<p>
Automated build from commit <code><a href="{repo}/commits/{commit_long}">{commit}</a></code> Automated build from commit <code><a href="{repo}/commits/{commit_long}">{commit}</a></code>
on {now.strftime('%Y-%m-%d')}. on {now.strftime('%Y-%m-%d')}.
</p> </p>
@ -91,7 +91,7 @@ on {now.strftime('%Y-%m-%d')}.
These are automatic per-commit builds generated from the main Git branch. These are automatic per-commit builds generated from the main Git branch.
We do not generate any release notes for these builds. You can view the full We do not generate any release notes for these builds. You can view the full
commit history <a href="{repo}">on GitHub</a> for all changes. commit history <a href="{repo}">on GitHub</a> for all changes.
</p> </p>]]>
""" """
elem = ET.SubElement(item, "enclosure") elem = ET.SubElement(item, "enclosure")
elem.set("url", f"https://tip.files.ghostty.org/{commit_long}/Ghostty.dmg") elem.set("url", f"https://tip.files.ghostty.org/{commit_long}/Ghostty.dmg")