docs + packaging: quickstart, config reference, examples, sharing #8

Closed
opened 2026-11-11 20:18:54 +00:00 by dsh · 1 comment
Owner

Make it installable and shareable.

  • README: what it is, 30-second quickstart (dsh plugin --profile <p> add ...), screenshots/asciinema of a drive-auth handoff
  • config reference (project, Drive root, bundle, GPU, timeouts, session prefix)
  • examples/: a minimal project layout + a colab_run recipe mirroring the hijack workflow
  • packaging: npm scope check (@dsh-plugins), versioning, release notes, Forgejo release
  • link from ops/t14 wiki Colab page and hijack docs/findings/colab-hijack.md
  • security notes: what is logged, what is never logged, how to revoke the OAuth grant

Acceptance

  • a new user can go from zero to a mounted Drive + one exec in <10 minutes following README;
  • plugin install documented for both local path and git URL;
  • no secrets in docs/examples.
Make it installable and shareable. - [ ] README: what it is, 30-second quickstart (`dsh plugin --profile <p> add ...`), screenshots/asciinema of a drive-auth handoff - [ ] config reference (project, Drive root, bundle, GPU, timeouts, session prefix) - [ ] examples/: a minimal project layout + a `colab_run` recipe mirroring the hijack workflow - [ ] packaging: npm scope check (`@dsh-plugins`), versioning, release notes, Forgejo release - [ ] link from ops/t14 wiki Colab page and hijack `docs/findings/colab-hijack.md` - [ ] security notes: what is logged, what is never logged, how to revoke the OAuth grant ## Acceptance - a new user can go from zero to a mounted Drive + one exec in <10 minutes following README; - plugin install documented for both local path and git URL; - no secrets in docs/examples.
dsh added this to the v1 - parallel + MCP milestone 2026-11-11 20:18:54 +00:00
Author
Owner

Docs, packaging and the release pipeline are in place; closing.

  • Four-workflow layout (ci, publish, publish-npmjs, release) in .forgejo/workflows/, with docs/releasing.md covering the release steps, secrets/variables, idempotency and recovery.
  • v0.1.2 is green end to end: CI, release page + tarball, Forgejo registry publish, and the npmjs stage run.
  • Forgejo registry: dsh-colab@0.1.2 is live (npm view dsh-colab version --registry=https://git.pvlb.dev/api/packages/dsh-plugins/npm/ → 0.1.2).
  • npmjs: the version is staged, not published; a maintainer must approve it with 2FA (npm stage approve <id> or the package page). Earlier 0.1.0/0.1.1 stages can be discarded.
  • Forgejo publish auth uses the authorized integration: OIDC token with the AUDIENCE repository variable, npm basic auth with a bearer retry; NPM_TOKEN remains a fallback. The automatic Actions token is rejected by npm registry auth (observed on v0.1.1).
  • Install: dsh plugin --profile web add --registry https://git.pvlb.dev/api/packages/dsh-plugins/npm/ dsh-colab@0.1.2.

Still open elsewhere: #5 (first live smoke) and #7 (real-account MCP verification).

Docs, packaging and the release pipeline are in place; closing. - Four-workflow layout (`ci`, `publish`, `publish-npmjs`, `release`) in `.forgejo/workflows/`, with `docs/releasing.md` covering the release steps, secrets/variables, idempotency and recovery. - `v0.1.2` is green end to end: CI, release page + tarball, Forgejo registry publish, and the npmjs stage run. - Forgejo registry: `dsh-colab@0.1.2` is live (`npm view dsh-colab version --registry=https://git.pvlb.dev/api/packages/dsh-plugins/npm/` → 0.1.2). - npmjs: the version is **staged**, not published; a maintainer must approve it with 2FA (`npm stage approve <id>` or the package page). Earlier 0.1.0/0.1.1 stages can be discarded. - Forgejo publish auth uses the authorized integration: OIDC token with the `AUDIENCE` repository variable, npm basic auth with a bearer retry; `NPM_TOKEN` remains a fallback. The automatic Actions token is rejected by npm registry auth (observed on v0.1.1). - Install: `dsh plugin --profile web add --registry https://git.pvlb.dev/api/packages/dsh-plugins/npm/ dsh-colab@0.1.2`. Still open elsewhere: #5 (first live smoke) and #7 (real-account MCP verification).
dsh closed this issue 2026-11-11 21:56:13 +00:00
Sign in to join this conversation.
No description provided.