Skip to content

Say when a build needs one runner per platform, and document the workflow's inputs - #922

Merged
manuelmayer-dev merged 1 commit into
mainfrom
docs/per-platform-build-and-workflow-inputs
Sep 17, 2026
Merged

manuelmayer-dev merged 1 commit into
mainfrom
docs/per-platform-build-and-workflow-inputs

Conversation

@manuelmayer-dev

Copy link
Copy Markdown
Member

Follow-up to the build-per-platform support in Macro-Deck-App/GitHub-Actions#3. The docs described merge and build --rid correctly, but never said when a build needs them - and the CI page opened with a matrix, which reads as the way to build a plugin in CI.

cli/ci.md

  • New section One runner, or one per platform before the matrix: build without --rid builds every declared runtime identifier from one Linux runner; split only for a target that cannot be cross-built (net10.0-windows, a native library, a build step needing Windows or macOS tooling). Rule of thumb: if a plain build succeeds on Ubuntu, you do not need the matrix.
  • Points at build-per-platform for anyone publishing through publish-plugin.yml, instead of hand-writing the matrix.
  • Both install steps use --version 3.0.0-beta.11, and the note explains why --prerelease is no longer the newest one.

creator-portal/release-workflow.md

  • The input table listed 8 of the workflow's 15 inputs. It now lists them all: build-per-platform, runners, run-tests, test-path, run-stub-host, platform-url, audience were missing, and cli-version's default was newest prerelease, which is no longer what the action does.
  • New section Building each platform on its own runner: what it changes (tests and dependency list run once, upload-artifact keeps the merged package, the runner-per-platform table, runners, no fail-fast) and what merge refuses.

cli/index.md

The install page claimed only -preview versions are published. SemVer orders beta before preview, so --prerelease resolves to 3.0.0-preview.10 while the newest release is 3.0.0-beta.11 - the one that has merge. The page now says so and gives the --version install.

Not in this PR

introduction/quickstart.md, introduction/manual-setup.md, guides/troubleshooting.md, reference/sdk-packages.md and sdk/src/MacroDeck.Plugin.Cli/README.md still install with --prerelease, so they all hand out preview.10. Pinning 3.0.0-beta.11 in each would go stale on the next release; the real fix is a prerelease label that sorts after preview (or a stable/rc). Worth doing before 3.0 either way.

Verified: npm run build in docs/ - 120 pages, all internal links valid.

…flow's inputs

The CI page opened with a matrix, so splitting the build read like the way to build a
plugin in CI. It is not: `build` without `--rid` builds every runtime identifier the
manifest declares from one Linux runner, and only a target that cannot be cross-built - a
net10.0-windows target, a native library, a build step needing Windows or macOS tooling -
needs a runner per platform. The page now says so before the matrix, and points at
build-per-platform for anyone publishing through publish-plugin.yml rather than writing
the matrix by hand.

The release workflow reference had grown stale: it listed eight of the workflow's fifteen
inputs. It now lists them all, including build-per-platform and runners, with a section on
what splitting the build changes.

`--prerelease` also stopped meaning "the newest one": SemVer orders `beta` before
`preview`, so it resolves to 3.0.0-preview.10 while the newest release is 3.0.0-beta.11 -
which is the one that has `merge`. The CI examples install by version, and the CLI's
install page says why. Every other install snippet still says `--prerelease`; they want the
prerelease labels fixed, not a pinned version each.
@manuelmayer-dev
manuelmayer-dev merged commit d31777b into main Sep 17, 2026
1 of 9 checks passed
@manuelmayer-dev
manuelmayer-dev deleted the docs/per-platform-build-and-workflow-inputs branch September 17, 2026 20:28
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.

1 participant