Skip to content

Software Requirements Glossary

sergio velderrain edited this page Nov 16, 2026 · 1 revision

Glossary

  • Engine: this repository (VITechnologies/projectbuddy), as distinct from any consumer repository that uses it.
  • Consumer / consuming repository: a separate repository (e.g. VITechnologies/SandboxSBOMReporting) that pins and invokes this engine's reusable workflows/scripts, supplying its own real, private project configuration.
  • Fork: a GitHub fork of this engine used for day-to-day active development (svelderrainruiz/projectbuddy), distinct from "consumer" above -- a fork develops the engine itself; a consumer only uses it.
  • Disclosed narrow-purpose exception: a script intentionally hardcoding one specific known consumer's identifiers, explicitly documented as such (e.g. docker/windows-sbom/Build-LvlibpCandidate.ps1), carved out of REQ-001's general zero-identifiers guarantee rather than treated as a bug. REQ-001 lists every disclosed exception; anything not on that list is a violation.
  • Fit Criterion: the ISO/IEC/IEEE 29148 term for an objective, checkable test of whether a requirement is actually met.
  • Gate: a pass/fail checkpoint in the SBOM pipeline (e.g. the Dependency-Track policy gate, the Grype severity gate) -- distinct from a repo-standards-review compliance gate (CM/coverage/REQ/ARCH/DOC), which is a different, unrelated use of the same word.
  • Lane workload: a consumer-declared command, with its candidate commit, inputs, outputs, working directory, timeout, toolchain contract, and secret names, that the engine runs in a lane without interpreting (REQ-090).
  • Toolchain contract: the consumer-declared list of tools, each with a probe argument vector, an extraction pattern, and an exact expected version, that a lane must match before the workload starts (REQ-091).
  • Evidence record: the one projectbuddy/lane-evidence@1 record per lane run that binds the candidate, the declaration, the lane, the observed toolchain, and the output digests; it is unsigned and does not by itself authenticate the evidence (REQ-092).
  • Requester: the non-human identity (an agent session, a bot, or a scheduled workflow) that submits a request for a privileged action; it is never an eligible reviewer (REQ-096).
  • Reviewer: a human GitHub user or team listed as a required reviewer of an approval environment; one reviewer's approval or rejection decides a request (SYS-REQ-028).
  • Approval environment: a GitHub Actions environment, one per action class, whose required reviewers gate each request and whose secrets are the only credentials that can perform it (REQ-098). The gate is enforcing when the requester cannot act directly and advisory otherwise (REQ-096).
  • Action class: a named kind of privileged action from a closed list, such as a wiki publish or a release-promotion merge, with its own target pattern, approval environment, and credential (REQ-094).

Clone this wiki locally