Skip to content

Commit ed0a4e8

Browse files
mschmickingclaude
andcommitted
style: stop prettier flip-flopping on the checklist
The publish section used deeply indented content inside a numbered list. Prettier reformatted it on every run without ever converging, so format:check failed no matter how many times --write was applied. Flattened to a top-level list with fenced blocks and an unindented table. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 76a8725 commit ed0a4e8

1 file changed

Lines changed: 29 additions & 29 deletions

File tree

docs/GOING-PUBLIC.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -115,45 +115,45 @@ release-please then opens a "chore(main): release 1.0.0" PR that bumps
115115
Provenance and OIDC both require a **public** repository, and a trusted publisher can
116116
only be attached to a package that already exists. That fixes the order:
117117

118-
1. [ ] **Make the repository public** (Settings → General → Danger Zone)
118+
- [ ] **Make the repository public** (Settings → General → Danger Zone)
119119

120-
2. [ ] **Wait for CodeQL's first run** and read the findings. It has skipped itself the
121-
whole time, so its output is genuinely unknown. Going public is reversible;
122-
`npm publish` is not.
120+
- [ ] **Wait for CodeQL's first run** and read the findings. It has skipped itself the
121+
whole time, so its output is genuinely unknown. Going public is reversible;
122+
`npm publish` is not.
123123

124-
3. [ ] Remove the `> **Not released yet.**` note from the README quick start and the
125-
`RELEASE CHECKLIST` comment beside it.
124+
- [ ] Remove the `> **Not released yet.**` note from the README quick start, and the
125+
`RELEASE CHECKLIST` comment beside it.
126126

127-
4. [ ] **Publish once by hand**, from a machine where npm works — no token involved:
127+
- [ ] **Publish once by hand**, from a machine where npm works. No token is involved:
128128

129-
npm login # interactive, honours your 2FA
130-
npm publish --access public
131-
132-
This is the only publish that needs a human. It exists purely so the package name
133-
is registered and can be configured.
129+
```bash
130+
npm login # interactive, honours your 2FA
131+
npm publish --access public
132+
```
134133

135-
5. [ ] **Attach the trusted publisher** at
136-
`npmjs.com/package/iobroker-sync/access` → Trusted Publisher → GitHub Actions:
134+
This is the only publish that needs a human. It exists purely so the package name is
135+
registered and can then be configured.
137136

138-
| Field | Value |
139-
| --- | --- |
140-
| Organization or user | `mschmicking` |
141-
| Repository | `iobroker-sync` |
142-
| Workflow filename | `release.yml` |
143-
| Environment | *(leave empty)* |
144-
| Allowed actions | `npm publish` |
137+
- [ ] **Attach the trusted publisher** at `npmjs.com/package/iobroker-sync/access`
138+
Trusted Publisher → GitHub Actions. All fields are **case-sensitive and exact**:
145139

146-
All fields are **case-sensitive and exact**.
140+
| Field | Value |
141+
| -------------------- | --------------- |
142+
| Organization or user | `mschmicking` |
143+
| Repository | `iobroker-sync` |
144+
| Workflow filename | `release.yml` |
145+
| Environment | _(leave empty)_ |
146+
| Allowed actions | `npm publish` |
147147

148-
6. [ ] From here on, releases run themselves: **Actions → Release to npm**, first with
149-
`dry_run: true` to read the file list, then `dry_run: false`.
148+
- [ ] From here on releases run themselves: **Actions → Release to npm**, first with
149+
`dry_run: true` to read the file list, then `dry_run: false`.
150150

151-
7. [ ] Verify: `npm view iobroker-sync`, then in a clean directory
152-
`npm i -g iobroker-sync && iob-sync --help`. The npm page should show a
153-
**Provenance** badge — it is generated automatically under OIDC.
151+
- [ ] Verify: `npm view iobroker-sync`, then in a clean directory
152+
`npm i -g iobroker-sync && iob-sync --help`. The npm page should show a
153+
**Provenance** badge, generated automatically under OIDC.
154154

155-
> The window between step 1 and step 4 is the only time the README promises a package
156-
> that does not exist. Keep it short.
155+
> The window between making the repository public and the first publish is the only time
156+
> the README promises a package that does not exist. Keep it short.
157157
158158
## 5. After going public
159159

0 commit comments

Comments
 (0)