Repository navigation
Add a release badge and a Compatibility section to the README - #40
Merged
Zach Hooper (XBOX) (zachhooper) merged 1 commit intoNov 19, 2026
Merged
Zach Hooper (XBOX) (zachhooper) merged 1 commit into
Zach Hooper (XBOX) (zachhooper) merged 1 commit into
Conversation
Add a "Latest release" badge as the first badge in the README badge row. It reads the latest GitHub release through shields.io, so it updates on its own when a release is published. Add a Compatibility section between "What works where" and Requirements, modeled on the Compatibility section in the XBOX Godot Sample README: - Godot Engine: a dynamic badge that reads GODOT_VERSION from .github/workflows/ci.yml, the 4.6 floor that project.godot declares, and a link to the sample's list for the addons' wider range. - Microsoft GDK: the sample's dynamic badge over its .github/gdk-versions.json, and how tools\sync_addons.ps1 chooses the edition it builds against and where the XBOX Series X|S redistributables come from. Link the Requirements GDK bullet to the new section. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7bdd2e59-619d-456d-9f1e-f1f8d987fd16
Zach Hooper (XBOX) (zachhooper)
requested review from
a team
and
a balanced review from Copilot
November 19, 2026 02:00
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are recorded for this README-only update to release and compatibility information.
No open issues 🎉
What changed in this PR
This README-only update makes release and compatibility information easier to find, with dynamic badges sourced from GitHub releases and CI configuration.
Changes:
- Adds a latest-release badge beneath the banner.
- Adds a Compatibility section showing the Godot version tested in CI and the sample’s supported GDK editions, with explanations of version requirements and addon builds.
- Links the GDK requirement to the new section.
| File | Description |
|---|---|
| README.md | Adds release and compatibility badges, explains their sources, and links requirements to compatibility details. |
Review effort: Balanced
James Lenell (jameslen-atg)
approved these changes
Nov 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a release badge to the top of the README, plus a Compatibility section for the supported Godot and Microsoft GDK versions. The section is modeled on the Compatibility section in the XBOX Godot Sample README. The new badges read their values live, so they stay current without README edits.
Changes
Latest releaseis now the first badge in the row under the banner. It reads the latest GitHub release through shields.io and showsv0.3.0today.## Compatibilitysection sits between "What works where" and "Requirements". It follows the sample's layout: one badge per subsection, then a "Source:" line.GODOT_VERSIONfrom.github/workflows/ci.yml(4.6.2today), the 4.6 floor thatproject.godotdeclares, and a link to the sample's list for the addons' wider range..github/gdk-versions.json(260404, 260403, 260402, 260401, 251002, 251001today). A short note explains howtools\sync_addons.ps1chooses the edition it builds against and links to Addon maintenance.Review notes
4.7.1-stable, 4.6.1-stable, 4.5.1-stable.project.godotdeclares the4.6feature tag, so listing 4.5.1 would overstate what NetRumble supports. The text links to the sample's list for the addons on their own.main, not the submodule pin. It needs no upkeep, and the file is identical at the pin (3639dfb) and onmaintoday. The trade-off: if the sample adds an edition before NetRumble moves its pin, the badge shows it first. Pointing the badge at the pinned commit would be exact, but every pin move would then need a README edit.sync_addons.ps1builds the PC addons against the edition vcpkg restores for the pin (ms-gdk2604.4.7897, edition 260404). The installed edition supplies the XBOX Series X|S redistributables, not the libraries the PC addons link against. The section says this rather than implying each listed edition was tested with NetRumble.docs/addon-maintenance.mdline 116 still names2accce5as the current sample pin, but the submodule points at3639dfb. That is left for a separate change.Testing
release: v0.3.0,Godot: 4.6.2, andMicrosoft GDK: 260404, 260403, 260402, 260401, 251002, 251001.tools\check-deport.ps1 -Detailedandtools\check-game-config.ps1pass, andgit diff --checkis clean..gdfiles change.