Skip to content

Commit 6475b6b

Browse files
committed
Keep the Marketplace channel unlisted until the first publish
The Marketplace listing and @v0 only resolve after the one-time Developer Agreement acceptance and the first release that ships action.yml. Listing it before then would show a dead "Available on" link, so hide it until live (the WinGet pattern): - Set unlisted: true on the channel; sync-channels keeps it out of the website install picker and the "Available on" strip. - Re-add the install-guide table glob exclusion, and exclude it from the release-pipeline push table too (Marketplace publish is a manual checkbox, not a credentialed automated job). - Add Operational Checklist item 8 in release.md: accept the Marketplace agreement on the first action release. The channel doc carries the full one-time steps and the flip-when-live instructions. The action.yml, the marketplace-major-tag workflow, and the docs stay in place; only the user-facing listings wait for the first publish. https://claude.ai/code/session_01TKgJTS4UcFPqtdwkxYzTUC
1 parent 78f5545 commit 6475b6b

4 files changed

Lines changed: 17 additions & 21 deletions

File tree

docs/development/release-channels/github-actions.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ credential: GITHUB_TOKEN
1616
job: release
1717
channelurl: https://github.com/marketplace/actions/mdsmith
1818
weight: 15
19+
unlisted: true
1920
---
2021
# GitHub Actions
2122

@@ -86,3 +87,10 @@ and `@v0` resolve. Until then, pin to a commit SHA on
8687
You can also skip the action entirely. Run the release
8788
binary in a `run:` step. That repeats by hand the download
8889
and verify steps the action automates.
90+
91+
While the listing is pending, the channel stays hidden. It
92+
sets `unlisted: true`. `sync-channels` then keeps it out of
93+
the install picker and the "Available on" strip. The
94+
install-guide and release-pipeline tables exclude it by
95+
glob. Flip `unlisted` and drop both glob exclusions once the
96+
listing resolves.

docs/development/release.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,14 @@ summary: >-
1212
---
1313
# Release Pipeline
1414

15-
`.github/workflows/release.yml` publishes mdsmith to every
16-
channel below. Release-time secrets travel as short-lived
17-
OIDC tokens. The remaining long-lived PATs are gated by the
18-
`release` GitHub environment. Each channel has its own file
19-
under `release-channels/`; the catalog re-renders on
20-
`mdsmith fix`.
15+
`.github/workflows/release.yml` publishes mdsmith to every channel
16+
below. Release-time secrets travel as short-lived OIDC tokens. The
17+
remaining long-lived PATs are gated by the `release` GitHub
18+
environment. Each channel has its own file under `release-channels/`;
19+
the catalog re-renders on `mdsmith fix`.
2120

2221
<?catalog
23-
glob: ["release-channels/*.md", "!release-channels/proto.md"]
22+
glob: ["release-channels/*.md", "!release-channels/{proto,github-actions}.md"]
2423
where: 'mechanism: "push"'
2524
sort: title
2625
header: |
@@ -31,7 +30,6 @@ row: "| [{title}]({filename}) | <{channelurl}> | {credential} |"
3130
| Channel | Release page | Credential |
3231
| -------------------------------------------------------------------------- | --------------------------------------------------------------------- | ----------------------- |
3332
| [Flatpak](release-channels/flatpak.md) | <https://github.com/jeduden/mdsmith/releases> | GITHUB_TOKEN + OIDC |
34-
| [GitHub Actions](release-channels/github-actions.md) | <https://github.com/marketplace/actions/mdsmith> | GITHUB_TOKEN |
3533
| [GitHub Releases](release-channels/github-releases.md) | <https://github.com/jeduden/mdsmith/releases> | GITHUB_TOKEN + OIDC |
3634
| [npm](release-channels/npm.md) | <https://www.npmjs.com/package/@mdsmith/cli> | OIDC Trusted Publishing |
3735
| [Obsidian](release-channels/obsidian.md) | <https://github.com/jeduden/mdsmith/releases> | GITHUB_TOKEN + OIDC |
@@ -379,6 +377,8 @@ place.
379377
set. With `gate` in every credential job's `needs:`,
380378
it is the only release gate, and the workflow (not a
381379
maintainer) creates the tag.
380+
8. [ ] Accept the GitHub Marketplace agreement on the
381+
first action release (see `release-channels/github-actions.md`).
382382

383383
## Verifying a Released Artifact
384384

docs/guides/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ glob:
4343
- "../development/release-channels/*.md"
4444
- "!../development/release-channels/proto.md"
4545
- "!../development/release-channels/winget.md"
46+
- "!../development/release-channels/github-actions.md"
4647
where: 'artifact: "cli"'
4748
sort: numeric:weight
4849
header: |
@@ -64,7 +65,6 @@ row: "| {title} | `{command}` | {audience} |"
6465
| GitHub Releases | `curl -LO https://github.com/jeduden/mdsmith/releases/latest/download/mdsmith-<os>-<arch>` | Air-gapped hosts and direct binary control |
6566
| Scoop | `scoop install mdsmith` | Windows users with Scoop installed |
6667
| Flatpak | `curl -LO https://github.com/jeduden/mdsmith/releases/latest/download/mdsmith-x86_64.flatpak && flatpak install ./mdsmith-x86_64.flatpak` | Sandboxed Linux x86_64 desktops via Flatpak |
67-
| GitHub Actions | `uses: jeduden/mdsmith@v0` | Linting Markdown inside GitHub Actions CI |
6868
<?/catalog?>
6969

7070
A bare `mise use mdsmith@latest` needs a registry entry —

website/data/channels.yaml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -174,15 +174,3 @@
174174
- editor
175175
url: https://github.com/jeduden/mdsmith/releases
176176
weight: 14
177-
- title: GitHub Actions
178-
summary: 'A composite action at the repository root downloads the checksum-verified release binary for the runner''s OS and architecture and puts `mdsmith` on `PATH`; published to the GitHub Marketplace and referenced as `uses: jeduden/mdsmith@v0`.'
179-
mechanism: push
180-
artifact: cli
181-
command: 'uses: jeduden/mdsmith@v0'
182-
audience: Linting Markdown inside GitHub Actions CI
183-
platforms:
184-
- linux
185-
- macos
186-
- windows
187-
url: https://github.com/marketplace/actions/mdsmith
188-
weight: 15

0 commit comments

Comments
 (0)