Files
pipdock/docs/RELEASE-CI.md
T
poli0981andClaude Opus 5 8f6b7ed24b feat: scaffold the Tauri shell, React UI and CI
Completes the Phase 0 scaffold. The app builds, links and renders; no
screens yet.

Frontend (ARCHITECTURE section 9, UI-SPEC section 2):
- React 19 + Vite 8 + Tailwind 4 with the UI-SPEC dark terminal-tech
  tokens, plus a contrast test asserting WCAG AA over every
  text/surface pair, which UI-SPEC section 8 requires be verified.
- EN and VI catalogs with a test that vi has every en key and no
  orphans, standing in for the CI parity script I18N section 1 asks for.
- A local eslint rule enforcing the no-hardcoded-JSX-strings policy.
  eslint-plugin-react was the obvious choice but caps at ESLint 9, which
  drags in six high-severity advisories that would fail npm audit in CI;
  a local rule also implements the documented allowlist (product name,
  package names, versions, catalog codes, glyphs) precisely, which
  react/jsx-no-literals cannot express. Verified it fires on real copy
  and stays quiet on all five allowed shapes.
- no-restricted-imports keeps invoke() out of components, so the
  "no component calls invoke directly" rule is enforced, not just stated.

Tauri (ARCHITECTURE section 7): commands and events only, identifier
com.skullmute.pipdock, NSIS and MSI targets, minimal capability set,
placeholder icon pending the Phase 3 branding pass.

CI (docs/RELEASE-CI.md section 1 as corrected):
- ci-rust.yml and release.yml are project-local, on Windows runners,
  because no reusable Rust or Tauri workflow exists in the ops repo.
  Windows matters here: env discovery reads the PEP 514 registry and the
  py launcher, so a Linux run would skip the code most likely to break.
- ci-node.yml calls the ops web-react reusable and adds the npm audit
  job that reusable lacks.
- codeql.yml is JS/TS only; CodeQL has no Rust analyzer.
- Discord notifiers replace the six-platform notify.yml that never
  existed. Every caller carries an explicit permissions block.
- Action versions checked against the registry rather than assumed:
  checkout v7, cache v6, gh-release v3, setup-node v6.

Two toolchain holds, both forced and both recorded:
- TypeScript 6.0.3, not 7: typescript-eslint peers on <6.1.0.
- ESLint 10 with eslint-plugin-react dropped, as above.

Verified: cargo fmt/clippy -D warnings/28 tests green, tsc clean,
18 vitest tests green, eslint clean, npm audit reports 0
vulnerabilities, vite build and both binaries link.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-07-27 17:44:39 +07:00

6.3 KiB

PipDock — Release & CI

Version 0.2 · 2026-07-27 · CI reuses the poli0981/.github ops repo where a suitable reusable workflow exists, and is project-local where one does not. The ops repo's suite was audited on 2026-07-27 (see §1 note) — do not assume a reusable exists without checking.

1. Workflows (.github/workflows/)

Workflow Kind Triggers Jobs
ci-rust.yml project-local PR, push main windows-latest: cargo fmt --check, clippy -D warnings, cargo test --locked, cargo audit
ci-node.yml caller → ops reusable-web-react.yml + one local job PR, push main Node 24, npm ci, lint / typecheck / Vitest (each runs only if the npm script exists), vite build; local job adds npm audit --audit-level=high
ci-integration.yml project-local PR touching engine|plan|snapshot|graph, nightly Windows runner, disposable-venv suite (TESTING L2), weekly latest-engine parser job
codeql.yml caller → ops reusable-codeql.yml PR, schedule languages: '["javascript-typescript"]' only
release.yml project-local tag v* windows-latest build, sign, bundle, publish (see §3)
announce-release.yml caller → ops announce-release.yml release published Discord release announcement
notify-ci-failure.yml caller → ops notify-ci-failure.yml workflow_run completed Discord CI-failure notification

Ops-repo audit (2026-07-27) — why the table looks like this:

  • The reusable suite covers assembly, c-cpp, chrome-extension, desktop-csharp, go, jvm, macos-swift, php, python, r, ruby and web-react. There is no Rust reusable and no Tauri reusable, and only reusable-desktop-csharp.yml uses a Windows runner — hence ci-rust.yml and release.yml are project-local.
  • reusable-web-react.yml has no working-directory input (it runs npm ci at the repo root — hence package.json lives at the root with Vite's root: './ui', see ARCHITECTURE §2) and no npm audit step, hence the extra local job.
  • reusable-codeql.yml supports csharp, python, javascript-typescript, ruby, c-cpp, java-kotlin, go and swift. CodeQL has no Rust analyzer, so Rust security coverage comes from clippy -D warnings + cargo audit in ci-rust.yml, not from CodeQL.
  • Portfolio notifications are Discord-only, driven by the ops repo's .github/scripts/discord_notify.py. There is no multi-platform notify.py.

Permissions matrix (explicit in every caller — the Phase-5 lesson: callers without a permissions: block default everything to none):

# codeql.yml
permissions: { actions: read, contents: read, security-events: write }
# announce-release.yml / notify-ci-failure.yml
permissions: { contents: read, actions: read }
# release.yml
permissions: { contents: write }        # release assets
# ci-*.yml
permissions: { contents: read }

2. Branch & version policy

main protected (PR + green CI required). SemVer; tags vX.Y.Z. Conventional commits feed the changelog generator.

Dependency updates use Dependabot (.github/dependabot.yml) — the portfolio standard, as evidenced by the ops repo's dependabot-summary.yml; there is no Renovate configuration anywhere in the ops repo. Four ecosystems: cargo, npm, github-actions, and pip scoped to tools-requirements.txt (the Code Health pins). Weekly schedule with minor/patch grouped per ecosystem; security advisories arrive as immediate, ungrouped PRs (Dependabot's default for security updates), and the pip ecosystem stays its own group so Code Health pin bumps are reviewable in isolation. Watching pip/uv releases to trigger the parser-fixture job is the scheduled job in ci-integration.yml, not the dependency bot.

3. Release pipeline (tag v*)

  1. Windows runner: npm ci && vite build → cargo tauri build --locked producing NSIS .exe + .msi.
  2. Sign updater artifacts with TAURI_SIGNING_PRIVATE_KEY (repo secret; public key baked into tauri.conf.json); generate latest.json for tauri-plugin-updater pointing at the GitHub Release assets.
  3. Compute and publish SHA256SUMS.txt.
  4. Draft GitHub Release with generated changelog; manual publish (owner review) → announce-release.yml fires the Discord announcement.
  5. Post-release checklist issue auto-opened: verify updater from previous version, verify SmartScreen behavior, spot-check EN/VI in the shipped build.

Secrets bootstrap: set per-repo with gh secret set (the ops repo has no setup-secrets.sh) — TAURI_SIGNING_PRIVATE_KEY and TAURI_SIGNING_PRIVATE_KEY_PASSWORD for the updater, plus the Discord webhooks the ops-repo notifiers expect (DISCORD_RELEASES_WEBHOOK, DISCORD_REPO_WEBHOOK, DISCORD_CI_WEBHOOK; the callers pass secrets: inherit).

4. Artifact & support policy

Two active lines at most: latest release gets features; previous minor gets security-only patches for 90 days. Updater always targets latest. MSI provided for org deployment; winget manifest submission is P2 (tracked in ROADMAP).

5. Repo scaffolding checklist (day one)

  • GPL-3.0 LICENSE at root; legal/ committed publicly (the in-app legal gate links to these GitHub URLs — CommandForge lesson: don't leave them gitignored).
  • .github/ISSUE_TEMPLATE/bug_report.yml (shipped in this suite) + config.yml disabling blank issues.
  • .github/dependabot.yml covering cargo, npm, github-actions and the Code Health pins.
  • rust-toolchain.toml, .nvmrc (24), Cargo.lock/package-lock.json committed.
  • Repo settings (owner, via the GitHub UI or gh — not committable): branch protection on main; disable Advanced Security → CodeQL Default setup (the reusable is advanced-setup and is rejected at upload time otherwise); enable Discussions for the issue-template contact links.
  • Secrets via gh secret set: TAURI_SIGNING_PRIVATE_KEY, TAURI_SIGNING_PRIVATE_KEY_PASSWORD, and the Discord webhooks (DISCORD_RELEASES_WEBHOOK, DISCORD_REPO_WEBHOOK, DISCORD_CI_WEBHOOK).
  • Generate the updater keypair (npx tauri signer generate) and replace the plugins.updater.pubkey placeholder in src-tauri/tauri.conf.json with the public half. Until then the updater cannot verify a release.
  • Replace the placeholder app icon (src-tauri/icons/) in the ROADMAP Phase 3 branding pass.
  • README badges: CI, CodeQL, release, license.