8. Glossary

Prev: 7.22. File handling

Next: (none)

Sections:

Overview

Short definitions of the terms used across this documentation, grouped by area. Each links to the page that covers it in full.

Committee - a PMC, or a PPMC for a podling. Committee membership is decided outside ATR. See Committee.
PMC - Project Management Committee, the body that oversees a top level project and votes on its releases.
PPMC - Podling Project Management Committee, the committee of a project in the Apache Incubator. See Podling releases.
Podling - a project in the Apache Incubator. Its releases are voted on twice, by the PPMC and then by the Incubator PMC.
Roster - the committers and PMC members of a committee, where committers can be designated as release managers.
Release manager - a person who guides a candidate through the compose, vote, and finish phases. See Release manager setup.

Project - the software, or bundle of software, that a committee votes on. A committee has one or more projects. See Project.
Release - a specific version of a project's software. See Release.
Release candidate - a release that has not yet been voted on and published.
Revision - a snapshot of a release candidate during the compose phase. Every change to the candidate's files makes a new revision. See Revision.
Artifact - a file in a release, such as a source archive, a binary, or an SBOM. See Artifact.
Cycle - a line of releases maintained together, such as all 2.x releases. See Lifecycle.
Version scheme - how a project numbers its releases and groups them into cycles.
Lifecycle event - a published record of a change in a release's status, such as end of distribution. See Lifecycle events.
Archived - a superseded release whose files have been removed from the distribution area but remain on archive.apache.org. See Archiving and lifecycle.
Catalog - the public list of every ASF release, current and archived. See Release catalog.

Compose phase - where a release candidate is assembled and checked. See Compose phase.
Vote phase - where the PMC decides whether the candidate becomes a release. See Vote phase.
Finish phase - where an approved candidate is published and announced. See Finish phase.
Check - an automated test that ATR runs on the artifacts in a revision. See Checks.
Blocker - a check result reporting a violation of mandatory policy, which stops the candidate going to a vote.
SBOM - software bill of materials, a list of the components in an artifact. See SBOM workflows.
Contingent Approval - a vote held through the Contingent Approval Portal (CAP), used to approve retiring a project. See Retiring a project.

Signing key - an OpenPGP key used to sign release artifacts. A committee's signing keys are its members' public keys. See Signing artifacts.
PAT - Personal Access Token, a credential that identifies you to ATR's API and command line tooling. See Access credentials.
JWT - JSON Web Token, a short-lived credential issued in exchange for a PAT.
Trusted Publishing - signing release artifacts automatically in a GitHub Actions workflow, available to projects with reproducible builds. See Trusted Publishing.
PURL - Package URL, a standard identifier given to every release in the catalog. See Package URLs.