IF Commons GitHub

governance/policy

Written to: 2 requirements: 2 proved, 0 partly, 0 failing, 0 with no test recorded. 0002-change-control-policy FR-001, 0002-change-control-policy FR-002

What a fleet decides about its own changes, as data: who the signers are (a name, a role, a public key), which paths are controlled and the roles whose approval a change to them needs. Nothing here reads Git or a key.

import { SIGNER_NAME } from "./policy.ts";
SIGNER_NAME.test("snshah-daily"); // true

Source: commons/change-control/src/governance/policy.ts

0 of 12 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

governance.KEY_LINEconstno test imports it
const KEY_LINE: RegExp

The public keys that Git can verify a signature with.

governance.SIGNER_NAMEconstno test imports it
const SIGNER_NAME: RegExp

A name of a signer or a role: lowercase letters, digits, dots and dashes, starting with a letter or a digit (it stands as the principal of an allowed_signers line).

governance.Controlledtypeno test imports it
type Controlled = { readonly path: string; readonly approvers: readonly string[] };

A path (or a family of paths) whose changes need approval, and the roles of the signers who may approve a change to it. A * stands for any characters but / and ** for any characters.

governance.Policytypeno test imports it
type Policy = { readonly signers: readonly Signer[]; readonly controlled: readonly Controlled[] };

What a fleet decides about its changes.

governance.SignatureStatetypeno test imports it
type SignatureState = "G" | "B" | "U" | "X" | "Y" | "R" | "E" | "N";

The state of the signature of a commit as Git says it: G good, B bad, U good by a key that is not trusted, X good but expired, Y good by an expired key, R good by a revoked key, E it could not be checked, N none.

governance.Signertypeno test imports it
type Signer = { readonly name: string; readonly role: string; readonly key: string; readonly added?: string; readonly retired?: string };

A signer of the fleet: its name (the principal of its signature), its role and its public key, the day it was added, and, for a key that was replaced, the last day its signatures count (a day, YYYY-MM-DD).

KEY_LINEconstno test imports it
const KEY_LINE: RegExp

The public keys that Git can verify a signature with.

SIGNER_NAMEconstno test imports it
const SIGNER_NAME: RegExp

A name of a signer or a role: lowercase letters, digits, dots and dashes, starting with a letter or a digit (it stands as the principal of an allowed_signers line).

Controlledtypeno test imports it
type Controlled = { readonly path: string; readonly approvers: readonly string[] };

A path (or a family of paths) whose changes need approval, and the roles of the signers who may approve a change to it. A * stands for any characters but / and ** for any characters.

Policytypeno test imports it
type Policy = { readonly signers: readonly Signer[]; readonly controlled: readonly Controlled[] };

What a fleet decides about its changes.

SignatureStatetypeno test imports it
type SignatureState = "G" | "B" | "U" | "X" | "Y" | "R" | "E" | "N";

The state of the signature of a commit as Git says it: G good, B bad, U good by a key that is not trusted, X good but expired, Y good by an expired key, R good by a revoked key, E it could not be checked, N none.

Signertypeno test imports it
type Signer = { readonly name: string; readonly role: string; readonly key: string; readonly added?: string; readonly retired?: string };

A signer of the fleet: its name (the principal of its signature), its role and its public key, the day it was added, and, for a key that was replaced, the last day its signatures count (a day, YYYY-MM-DD).

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