Skip to content

RELEASE.md

Latest commit

 

History

History
58 lines (40 loc) · 3.17 KB

RELEASE.md

File metadata and controls

58 lines (40 loc) · 3.17 KB
Raw

Release Process

Before changing manifest.json, creating a tag, building release artifacts, or publishing a GitHub release, state the proposed next version and justify it.

The version rationale must include:

  • The current latest release and tag.
  • The scope of the changes being released.
  • Why the proposed MAJOR.MINOR.PATCH level fits semantic versioning expectations.
  • The exact manifest Version value to use, including the fourth Elgato build component.
  • The exact Git tag to create.

Wait for explicit approval of that version rationale before making any release-version changes or running release commands.

When a hardware test has been approved and the related change is committed and pushed, handle the corresponding GitHub issue as part of the same publish flow. Close it when the release/publish completes, or update it with the exact remaining blocker if it cannot be closed yet.

Release notes must follow the same structure as recent releases:

  • Use a user-facing feature or "What's changed" heading.
  • Group entries under sections such as "New features", "Improvements", or "Bug fixes" when useful.
  • Always include a "Downloads" section listing the release artifact (com.moeilijk.hwinfo-X.Y.Z.streamDeckPlugin); there is no Linux artifact for this plugin.
  • Do not include a validation section; validation belongs in the final assistant summary, not in public release notes.

Elgato Marketplace release notes are separate from GitHub release notes. The plugin is Windows-only, so do not mention Linux, OpenDeck, release artifacts, downloads, validation, GitHub tags, commits, or hardware-test details there.

Use the existing Marketplace v1.7 style:

## What's new

### Feature title
Short user-facing explanation.

### Feature title
Short user-facing explanation.

## Fixes
- Short fix or compatibility note.

For Marketplace updates, write only the Windows-relevant delta since the currently published Marketplace version.

Marketplace status

A moeilijk Marketplace listing "HWiNFO" was submitted through the Maker Console on 26 July 2026 at version 3.0.0 (auto-publish enabled) and is awaiting Elgato review; do not reference it as published until it appears on the Marketplace. The older "HWiNFO" listing on the Marketplace belongs to the exension maker account and is not ours: never write changelogs against it or propose releasing under its identity. Once the moeilijk listing is published, look up its version on its product page (Version and "Last Updated" fields) and write the Marketplace changelog as the Windows-relevant delta since that version.

Steps

  1. Confirm the release scope and current latest release.
  2. Propose and justify the next version.
  3. Wait for explicit approval of the version rationale.
  4. Update Version in com.moeilijk.hwinfo.sdPlugin/manifest.json to MAJOR.MINOR.PATCH.0.
  5. Commit and push the release changes.
  6. Handle the GitHub issue or issues included in the committed scope.
  7. Run make release.
  8. Create the GitHub release with tag vMAJOR.MINOR.PATCH, English release notes, and the artifact attached:
    • com.moeilijk.hwinfo-MAJOR.MINOR.PATCH.streamDeckPlugin
  9. Confirm that the issue state matches the published release scope.