flowpact

The GITHUB_TOKEN default is read-only, the lowest setting, for both the ciatlas organization and the repository, and workflows cannot approve pull requests, so a job that sets no permissions gets read access only. Every workflow also sets its own top-level permissions: contents: read in most, {} in pr-title.yml, read-all in scorecard.yml, and in docs.yml contents: read with pages: write and id-token: write for the Pages deployment. Other write scopes are granted only on the jobs that use them (https://github.com/ciatlas/flowpact/tree/main/.github/workflows).

Every release gets a unique Semantic Versioning number and a vX.Y.Z tag, which release-please computes from Conventional Commit titles (https://github.com/ciatlas/flowpact/blob/main/release-please-config.json, https://github.com/ciatlas/flowpact/blob/main/CHANGELOG.md). npm never accepts a version twice, releases are immutable since 0.10.0, and a ruleset lets only the release bot and admins create, move or delete v* tags.

Every release has a descriptive changelog, both on its GitHub release page (https://github.com/ciatlas/flowpact/releases) and in https://github.com/ciatlas/flowpact/blob/main/CHANGELOG.md. It groups changes into breaking changes with upgrade steps, features, bug fixes and performance, written from user-facing PR titles. Security-relevant changes are listed too, for example 0.9.0's 'harden 0.9.0 before its release: flag values, plugins, report paths and release assets' and 0.12.1's bounded walking of linked directories.

The build and release pipelines take dependencies through pnpm, the project's standard package manager. The version is pinned in package.json's packageManager, and every CI and release job runs pnpm install --frozen-lockfile against the committed lockfile (https://github.com/ciatlas/flowpact/blob/main/.github/workflows/release.yml, https://github.com/ciatlas/flowpact/blob/main/.github/workflows/ci.yml). Workflow actions are pinned to commit SHAs and updated by Renovate.

The npm tarball, the Action archive and the .vsix each have a Sigstore-signed SLSA build provenance attestation from GitHub Actions, attached as .sigstore.json and .intoto.jsonl, and each CycloneDX SBOM is attested against its artifact. Since 0.10.0 every release is also an immutable GitHub release whose signed release attestation lists the SHA-256 of every attached file (gh release verify), and the npm package has npm provenance. See https://github.com/ciatlas/flowpact/blob/main/SECURITY.md#verifying-releases and https://ciatlas.github.io/flowpact/docs/security/#verify-a-release.

https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#dependencies describes how dependencies are selected (reviewed in a pull request, bundled into every artifact), obtained (pnpm with a frozen lockfile, a two-day minimum release age, install scripts only for allowlisted packages, @ciatlas/core from a release tag, actions pinned to commit SHAs) and tracked (Renovate, OSV vulnerability alerts, and an SBOM and license notices in every release).

https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#setup lists what a build needs: Node.js 22 or later, and pnpm, pinned in package.json and enabled with corepack enable. It also gives the commands. pnpm install fetches every dependency from the lockfile, including the workflow model @ciatlas/core from its GitHub release tag (explained in the next section). pnpm build bundles the CLI and the GitHub Action.

https://github.com/ciatlas/flowpact/blob/main/MAINTAINERS.md#access-to-sensitive-resources lists everyone and everything with access to the project's sensitive resources: the GitHub organization and repositories, the two GitHub Apps and their permissions, the release bot's credentials, and the npm, VS Code Marketplace, Azure and Open VSX accounts that publish releases.

https://github.com/ciatlas/flowpact/blob/main/MAINTAINERS.md#roles-and-responsibilities describes the roles (maintainer, contributors, the release bot, Renovate) and what each is responsible for, and how access is given and taken away when people join or leave.

https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#pull-requests sets the requirements for an acceptable contribution. They are a Conventional Commits PR title and the required CI checks: Biome lint, typecheck, tests on Node 22 and 24, line coverage of at least 80% overall and 90% in packages/lint, and fallow code health. A behaviour change needs tests, and a bug fix needs a test that fails without it. Docs and the committed action bundle must be regenerated, and a code owner must approve.

Every change reaches main through a pull request on GitHub (the main ruleset requires one and has no bypass, https://github.com/ciatlas/flowpact/blob/main/.github/rulesets/main.json). Under section D.6 of GitHub's Terms of Service, contributors to this MIT-licensed repository assert they have the right to license their contributions, as https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#pull-requests also states.

The live main ruleset has no bypass actors and requires the 'CI passed' and 'Conventional PR title' checks to pass on an up-to-date branch before any merge (https://github.com/ciatlas/flowpact/blob/main/.github/rulesets/main.json). 'CI passed' fails unless every CI job succeeds (https://github.com/ciatlas/flowpact/blob/main/.github/workflows/ci.yml). Renovate merges only when all checks are green. The other checks (CodeQL, code-scanning results) are informational, so merging past a failure in one of them is a manual action by the maintainer.

On every pull request, CI's Test job runs the Vitest suite of unit, property and end-to-end tests (pnpm coverage) on Node 22 and 24 (https://github.com/ciatlas/flowpact/blob/main/.github/workflows/ci.yml). CI also smoke-tests the packed CLI on Linux, macOS and Windows and the extension in VS Code. The main ruleset requires the aggregate 'CI passed' check and has no bypass actors, so nothing merges without these tests.

https://ciatlas.github.io/flowpact/docs/how-it-works describes the analysis step by step, from YAML to reports. https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#repository-layout names each component: the core model, lint, reporters, CLI/API, action, language server and extension. https://ciatlas.github.io/flowpact/docs/security covers every actor and action around them: the analyzed repository as untrusted input, plugins, what flowpact writes, the Action's two network calls and its token, and permissions. The release workflow, release bot and Renovate are covered there and in https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#releases.

Reference docs cover every external interface of the released assets. The CLI's commands, options, output formats, JSON report, exit codes and environment variables: https://ciatlas.github.io/flowpact/docs/cli. The Action's inputs, outputs, annotations and permissions: https://ciatlas.github.io/flowpact/docs/action. The programmatic API: https://ciatlas.github.io/flowpact/docs/api. The config, with JSON Schemas: https://ciatlas.github.io/flowpact/docs/configuration. Contracts: https://ciatlas.github.io/flowpact/docs/contracts. The plugin API: https://ciatlas.github.io/flowpact/docs/custom-rules. The language server and extension settings: https://ciatlas.github.io/flowpact/docs/editors.

The threat model at https://ciatlas.github.io/flowpact/docs/threat-model ranks the most likely and impactful security problems by residual risk, each with the mitigation in the code, the tests that cover it and the risk that remains; CONTRIBUTING.md asks to revisit it for new features and breaking changes.

https://github.com/ciatlas/flowpact/blob/main/SECURITY.md is the coordinated disclosure policy, also shown at https://github.com/ciatlas/flowpact/security/policy. Reports go privately through GitHub's private vulnerability reporting, with an acknowledgement within 3 working days and an assessment within 10. The advisory is published once a fixed release is available, crediting the reporter.

https://github.com/ciatlas/flowpact/blob/main/SECURITY.md#reporting-a-vulnerability directs reporters to GitHub's private vulnerability reporting form (https://github.com/ciatlas/flowpact/security/advisories/new) and not to public issues. The form is enabled for the repository, and reports reach the maintainer privately.

Vulnerabilities fixed in past releases are published in https://github.com/ciatlas/flowpact/blob/main/SECURITY.md#security-fixes-in-past-releases with the affected versions, how to tell whether you are affected and the fix; future ones are published as GitHub security advisories (https://github.com/ciatlas/flowpact/security/advisories) and named in the release notes.