Skip to content

docs(webkit): refresh GOVERNANCE_IMPLEMENTATION for release-please and the current CI pipeline - #820

Merged
robsongajunior merged 2 commits into
mainfrom
docs/governance-implementation-refresh
Jul 28, 2026
Merged

docs(webkit): refresh GOVERNANCE_IMPLEMENTATION for release-please and the current CI pipeline#820
robsongajunior merged 2 commits into
mainfrom
docs/governance-implementation-refresh

Conversation

@robsongajunior

Copy link
Copy Markdown
Contributor

Summary

Refreshes packages/webkit/docs/GOVERNANCE_IMPLEMENTATION.md — the governance-tooling rationale doc that ships to npm (package.json#files includes docs). It was a 2026-04 snapshot, resurrected by #768 after #741 deleted it, and had drifted from the tree on several load-bearing claims. Every statement in the refresh was verified against the current configs/workflows.

What was stale → what it says now:

  • .d.ts-at-publish mechanism — claimed .releaserc prepareCmd (semantic-release, deleted by ci: replace semantic-release with release-please (Release PR model) #798). Now: the publish workflow (package-webkit.yml) runs vue-tsc --declaration --emitDeclarationOnly immediately before npm publish, triggered by release-please's release: published.
  • CI section — described an 8-job pipeline triggering on main and dev. Now: the current 12-job governance.yml (adds lint-canary, smoke, tests ×4 shards, visual ×4 shards, each with a rationale subsection), main-only triggers, PR concurrency cancellation.
  • Security audit — claimed pnpm audit --audit-level=high. Now: plain pnpm audit (any severity fails; accepted risks live as pnpm-workspace.yaml overrides).
  • Config locations — ESLint flat config is the repo root file (packages/webkit/eslint.config.js is a one-line re-export) with hand-picked Vue rules rather than a spread preset; stylelint is the root .stylelintrc.json only; TS strictness is split across tsconfig.base.json + the webkit tsconfig (which also drives publish-time declaration emit).
  • Scripts & hooks — documents the root webkit:* delegation scripts, the governance-gate scripts (catalog:check, size, pack:check, test:gate, authoring, doc-standards, smoke:consume), the Vitest browser-mode test scripts, and the commit-msg/commitlint hook. The old "skip hooks with --no-verify in emergencies" tip is replaced with the git-workflow prohibition.
  • Housekeeping — a past-tense "Release Automation (2026-07)" migration note; "Future Improvements" split into shipped (bundle budgets, visual regression, functional tests, lint canaries) vs. still open; header carries "Implemented 2026-04-13 · Last refreshed 2026-07-28".

Closes #819 (the "refresh or delete" decision → refresh).

Notes

…d the current CI pipeline

The doc (shipped to npm via files: docs) still described the semantic-release/.releaserc mechanism deleted by #798 and an 8-job CI. Rewritten against the current tree: publish-workflow d.ts generation, 12-job governance pipeline with main-only triggers, plain pnpm audit, current scripts/hooks/config locations, and a historical release-automation migration note.
@robsongajunior
robsongajunior requested a review from a team as a code owner July 28, 2026 17:49
@robsongajunior
robsongajunior merged commit f4722dc into main Jul 28, 2026
23 checks passed
@robsongajunior
robsongajunior deleted the docs/governance-implementation-refresh branch July 28, 2026 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

docs: GOVERNANCE_IMPLEMENTATION.md resurfaced after #741 deletion and ships stale claims to npm — refresh or delete

3 participants