docs(readme): drop forge deployment and CI/CD details from the npm manual #73

Closed
opened 2026-11-07 23:39:06 +00:00 by dsh · 0 comments
Owner

The npm-facing manual doubles as a deployment runbook. README.md currently publishes the four Forgejo Actions workflows (triggers, secrets, registries), the release ritual, the updater's registry internals, the registry-tarball fallback URL and our runner/rootless-Docker constraint. Nobody installing dsh-gitea from npm needs any of that, and the runner/secret notes are operationally sensitive rather than useful.

Scope

Remove from README.md (the user manual: install, config, tool reference):

  • the whole ## CI, releases and versioning section (workflow table, secrets, registries, release ritual, versioning, updater internals) — the detail already lives in devops/releases.md; move anything unique there first.
  • the ### Fallback — the Forgejo registry tarball install method.
  • .forgejo/workflows / publish.yml references in Built on upstream and Repository layout.
  • the deployment sentence in Built on upstream and the CI gate phrasing in Development.

Keep: install, configure, verify, troubleshooting, the full toolset, Safety by default, Beyond the tools, the fork rationale, and contributor docs that are not ops runbooks.

Translations

README.zh.md / README.ru.md are refreshed in the release pass, not per change (devops/workflow.md) — the next tag must sync them against the trimmed README.md, so the npm tarball ships all three clean.

Acceptance

  • grep -nE '\.forgejo/workflows|NPM_TOKEN|NPMJS_TOKEN|RELEASE_TOKEN|api/packages' README.md → no hits.
  • no broken cross-reference or anchor left behind.
  • npm run check green (the leak scan covers README.md).
  • unique detail preserved in devops/releases.md.
The npm-facing manual doubles as a deployment runbook. `README.md` currently publishes the four Forgejo Actions workflows (triggers, secrets, registries), the release ritual, the updater's registry internals, the registry-tarball fallback URL and our runner/rootless-Docker constraint. Nobody installing `dsh-gitea` from npm needs any of that, and the runner/secret notes are operationally sensitive rather than useful. ## Scope Remove from `README.md` (the user manual: install, config, tool reference): - the whole `## CI, releases and versioning` section (workflow table, secrets, registries, release ritual, versioning, updater internals) — the detail already lives in `devops/releases.md`; move anything unique there first. - the `### Fallback — the Forgejo registry tarball` install method. - `.forgejo/workflows` / `publish.yml` references in `Built on upstream` and `Repository layout`. - the deployment sentence in `Built on upstream` and the `CI gate` phrasing in `Development`. Keep: install, configure, verify, troubleshooting, the full toolset, `Safety by default`, `Beyond the tools`, the fork rationale, and contributor docs that are not ops runbooks. ## Translations `README.zh.md` / `README.ru.md` are refreshed in the release pass, not per change (`devops/workflow.md`) — the next tag must sync them against the trimmed `README.md`, so the npm tarball ships all three clean. ## Acceptance - `grep -nE '\.forgejo/workflows|NPM_TOKEN|NPMJS_TOKEN|RELEASE_TOKEN|api/packages' README.md` → no hits. - no broken cross-reference or anchor left behind. - `npm run check` green (the leak scan covers `README.md`). - unique detail preserved in `devops/releases.md`.
dsh closed this issue 2026-11-07 23:44:04 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
dsh-plugins/dsh-gitea#73
No description provided.