IF Commons GitHub

Integrations GitHub connector

0001Active

0001-integrations-github-connector · owner if · domain commons

Requirements

FR-001checkpassing

The governance of the connector MUST be read-only (the contract says never, every grant is read), name the host the transport may reach, hold the credential as a reference to a vault store, and be valid under the governance checks of Integrations.

Enforced (check): .github: cd commons/integrations-github && bun run verify — suite/github.test.ts: the governance is read-only, scoped and valid

Proved by: integrations-github/suite/github.test.ts

Written in: integrations-github/about.ts, integrations-github/library.ts, integrations-github/src/mod.ts, integrations-github/tools/check.ts, integrations-github/tools/pack.ts

Tests: passed: suite/github.test.ts the governance is read-only, scoped, and valid

FR-002checkpassing

The connector MUST pass conformConnector over a recorded fixture of made-up answers with no finding.

Enforced (check): .github: cd commons/integrations-github && bun run verify — suite/github.test.ts: conformance finds nothing

Proved by: integrations-github/suite/github.test.ts

Written in: integrations-github/src/mod.ts

Tests: passed: suite/github.test.ts the conformance suite of Integrations finds nothing

FR-003checkpassing

The posture of an organization MUST be a set of facts judged by policies of GRC's vocabulary (two-factor required, no public repository, repositories present); an organization that does not require two-factor MUST fail its policy, and an unreadable list of administrators MUST be a gap and not a failure.

Enforced (check): .github: cd commons/integrations-github && bun run verify — suite/github.test.ts: a failed policy and a gap

Proved by: integrations-github/suite/github.test.ts

Written in: integrations-github/src/mod.ts

Tests: passed: suite/github.test.ts the posture without the requirement fails its policy, and denied administrators are a gap

FR-004checkpassing

No personal or secret field of a repository or a member MUST be kept in the observation.

Enforced (check): .github: cd commons/integrations-github && bun run verify — suite/github.test.ts: no personal or secret field is kept

Proved by: integrations-github/suite/github.test.ts

Written in: integrations-github/src/mod.ts

Tests: passed: suite/github.test.ts no personal or secret field of a repository is kept

Acceptance scenarios

  1. Given the synthetic fixtures of the suite, When the conformance suites of Integrations run over this plugin, Then they find nothing, per FR-001.

Out of scope

  • Everything the plugin does not list above: Planned, and specified in commons integrations 0007-integrations-standards where it is a standard.

Edge cases

  • A fixture that would be real data: never, every fixture is made up, per FR-001.

Assumptions

  • All answers in the tests are made up; no real organization, person or token is anywhere in this repository.

Open questions

  • None.

Key entities

  • Integrations GitHub - the plugin.

Success criteria

SC-001success criterion

The plugin passes the conformance suite of Integrations.

Review & acceptance checklist

  • [x] Every requirement is testable (MUST / MUST NOT), not aspirational
  • [x] No company fact is asserted here
  • [x] Every open item is marked, not silently decided

Cited by

Integrations GitHub, mod

Titles, headings, exports, tables, columns and requirements. Esc closes.