Skip to content

Add a release badge and a Compatibility section to the README - #40

Merged
Zach Hooper (XBOX) (zachhooper) merged 1 commit into
mainfrom
user/zachhooper/readme-release-compatibility
Nov 19, 2026
Merged

Zach Hooper (XBOX) (zachhooper) merged 1 commit into
mainfrom
user/zachhooper/readme-release-compatibility

Conversation

@zachhooper

Copy link
Copy Markdown
Contributor

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

  • Release badge. Latest release is now the first badge in the row under the banner. It reads the latest GitHub release through shields.io and shows v0.3.0 today.
  • Compatibility section. A new ## Compatibility section sits between "What works where" and "Requirements". It follows the sample's layout: one badge per subsection, then a "Source:" line.
    • Godot Engine: a dynamic badge that reads GODOT_VERSION from .github/workflows/ci.yml (4.6.2 today), 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 own badge over its .github/gdk-versions.json (260404, 260403, 260402, 260401, 251002, 251001 today). A short note explains how tools\sync_addons.ps1 chooses the edition it builds against and links to Addon maintenance.
  • Requirements. The Microsoft GDK bullet links to the new section.

Review notes

  • The Godot badge shows NetRumble's version, not the sample's list. The sample lists 4.7.1-stable, 4.6.1-stable, 4.5.1-stable. project.godot declares the 4.6 feature 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.
  • The GDK badge reads the sample's main, not the submodule pin. It needs no upkeep, and the file is identical at the pin (3639dfb) and on main today. 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.
  • The 2510 editions. The sample's list still includes 251002 and 251001. The sample's GDK release watch puts the 2510 family below its floor for new editions, because they lack GDK features the addons depend on, but keeps the 2510 editions already listed. Worth a look if NetRumble should advertise 2604 editions only.
  • What the installed edition does. sync_addons.ps1 builds the PC addons against the edition vcpkg restores for the pin (ms-gdk 2604.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.
  • Out of scope. docs/addon-maintenance.md line 116 still names 2accce5 as the current sample pin, but the submodule points at 3639dfb. That is left for a separate change.

Testing

  • Rendered each badge from shields.io: release: v0.3.0, Godot: 4.6.2, and Microsoft GDK: 260404, 260403, 260402, 260401, 251002, 251001.
  • Rendered the README through the GitHub Markdown API: every reference link resolves and every badge renders through camo.
  • tools\check-deport.ps1 -Detailed and tools\check-game-config.ps1 pass, and git diff --check is clean.
  • README only. No .gd files change.

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

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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

@zachhooper
Zach Hooper (XBOX) (zachhooper) merged commit 7727375 into main Nov 19, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants