Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
60b930f
Delete content/pages/atr/maven/README.md
dave2wave Aug 25, 2026
d770dd5
Update links in menu.html for Trusted Releases and Docs
dave2wave Aug 25, 2026
ea5c2c3
Add details about volunteer-led tools
dave2wave Aug 25, 2026
71cdc36
Add design document for Apache Trusted Releases
dave2wave Aug 25, 2026
6bdb040
Update atr-design-doc.md
dave2wave Aug 25, 2026
1829ae9
Fix HTML structure in menu template
dave2wave Aug 25, 2026
524da3e
Revise Trusted Releases documentation
dave2wave Aug 25, 2026
8639809
Update profile setting in .asf.yaml
dave2wave Aug 25, 2026
8a80918
Add release phases to trusted releases documentation
dave2wave Aug 25, 2026
0713c07
Document release phases in trusted releases
dave2wave Aug 25, 2026
c2d4782
Revise contribution details and update links in index.md
dave2wave Aug 25, 2026
db19053
Fix dropdown divider closing tag in menu.html
dave2wave Aug 25, 2026
7069dd8
Add links to ATR resources in index.md
dave2wave Aug 25, 2026
be35b8e
Update checkout action version in workflow
dave2wave Aug 25, 2026
382b83e
Update checkout action version in pre-commit.yml
dave2wave Aug 25, 2026
6a28583
Update pre-commit workflow to use specific cache version
dave2wave Aug 25, 2026
d6b408f
Remove extra blank lines in index.md
dave2wave Aug 25, 2026
59b4b09
Update checkout action version in workflow
dave2wave Aug 25, 2026
c1aef10
Update checkout and cache action comments in workflow
dave2wave Aug 25, 2026
6726c78
Fix syntax for setting PY in pre-commit workflow
dave2wave Aug 25, 2026
ddbcde7
Refine documentation for Apache Trusted Releases platform
dave2wave Aug 26, 2026
10be7da
Revise trusted releases documentation
dave2wave Aug 26, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .asf.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
staging:
profile:
profile: ~
autostage: preview/*

pelican:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-pelican.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
permissions:
contents: write # because we push to asf-site
steps:
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: true
ref: ${{ github.ref || 'main' }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Install
Expand All @@ -21,7 +21,7 @@ jobs:
pip install pre-commit
- name: Set PY
run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> "$GITHUB_ENV"
- uses: actions/cache@v4
- uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.0.1
with:
path: ~/.cache/pre-commit
key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
Expand Down
86 changes: 86 additions & 0 deletions content/pages/atr-design-doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
Title: Apache Trusted Releases design
license: https://www.apache.org/licenses/LICENSE-2.0

The main project is the Apache Trusted Releases platform. This is the initial design document.

Repositories:

- https://github.com/apache/tooling-trusted-releases
- https://github.com/apache/tooling-releases-client

## 1. Automate the Release Process

- Minimize human interaction.
- Community participation on **Release Votes** remains via email.
- Record all of the key events and metrics for tracking operations and performance.
- PMCs can quickly benefit.
- Infra costs and management complexity are decreased.

## 2. Community

- Work with a selection of **Apache** PMCs, **Incubator PPMCs(podlings)**, and **Infra** for **User Acceptance Testing (UAT)**.
- Co-ordinate with **Infra** on migration and operation.
- Contribute to Infra's **asfquart** and **asfpy** frameworks.
- Provide openings for volunteers to help so long as the contributions are adequate and timely.
- Assure that the **ATR platform** follows industry best practices especially regarding **SBOMs**,
**Certificate Management**, and **Digital Signatures**.
- Help lead the industry to better practices.
- Work within the **ASF** on **Release Policy** improvements.

## 3. Apache Trusted Release Platform (ATR)

- Incorporate all PMC Releases.
- Download page.
- Release Candidate page.
- Archived download page.
- Every PMC has a management interface.
- Current manual release practice is viewable.
- Automated release status.
- **KEYS** file management including revoking keys.
- Trigger release phases.
- Tracking performance.
- Platform includes a RESTful API.
- Serve release artifacts efficiently.
- Make switching from current manual release process to a minimal ATR process very simple.
- System Admins (Infra) have a management interface.
- Provide operational status to help Infra monitor ATR operations through the Infra Reporting Dashboard (IRD).
- Develop the platform with consideration about reusability outside of the ASF ecosystem, where feasible with regards to development costs.

See [Platform Services](platform.html) for detailed requirements for the **ATR**.

## 4. Automate Release Process around Compliance

- Meet Release Policy
- Legal Policy
- Infra Policy
- Security Policy
- SBOMs and Attestations
- Include dependency and license compliance.
- Provide clear attribution and information about Release Votes.
- Certificate and Credential Management
- Manage the signing keys needed for automation.
- Download Page including available SBOM and verification instructions.
- Announcement Email.

## 5. Release Lifecycle Phases

Here is a flow chart showing the [Release Lifecycle Phases](https://github.com/apache/tooling-docs/blob/main/apache-trusted-releases/lifecycle.md).

## 6. Infrastructure Requirements

- Run book for releases.apache.org
- Progress on the retirement path for `svn:dist`. See [Legacy Releases from SVN Dist](svn-dist.html)
for possible transitional states. For the beta test _transition 1B_ is preferred.
- Legacy urls for dist.apache.org, downloads.apache.org, dlcdn.apache.org, and archive.apache.org remain supported.
- Path schemes for downloads.apache.org, dlcdn.apache.org, and archive.apache.org remain.

## 7. Future Requirements

- Integrate with the [Security Advisory Process](https://github.com/apache/tooling-docs/blob/main/apache-trusted-releases/advisory-process.md) to make it easy to track applicable advisories on download pages.
- Expand support for [Evaluating Build Claims](https://github.com/apache/tooling-docs/blob/main/apache-trusted-releases/evaluate.md) to additional build tools.
- Expand automated support for additional [Distribution Channels](https://github.com/apache/tooling-docs/blob/main/apache-trusted-releases/distributions.md).
- Include a [Signing Candidates](https://github.com/apache/tooling-docs/blob/main/apache-trusted-releases/digital-signatures.md) phase during ATR processing.

> There are policy implications to the automation of digital signatures.
> For now, creating digital signatures on certain artifact types must be done prior to GPG signing and
> prior to submission of the release candidate.
4 changes: 0 additions & 4 deletions content/pages/atr/maven/README.md

This file was deleted.

23 changes: 12 additions & 11 deletions content/pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,19 @@ developed by ASF Infrastructure.
2. Automate the Release Process for the benefit of PMCs while also reducing infrastructure
costs and management complexity.

### Contribute to the Discussion

- Repository: https://github.com/apache/tooling-docs
- ASF Slack Channels: [#tooling-discuss](https://the-asf.slack.com/archives/C086X8CKEMB) – [#apache-trusted-releases](https://the-asf.slack.com/archives/C049WADAAQG)
- Mailing List: dev@tooling.apache.org – [archives](https://lists.apache.org/list.html?dev@tooling.apache.org)
- Subscribe to Mailing List: dev-subscribe@tooling.apache.org

### Apache Trusted Releases (ATR) platform

All ASF Projects may participate in our second Alpha testing the new automation framework.
All ASF PMCs and Incubating podlings may participate in Beta testing of our new [Trusted Releases](/trusted-releases.html) platform.

#### ATR Website

Login to the ATR using your ASF credentials and you will have access to your PMC's projects.
Incubating projects are welcome to join.

1. ATR: https://release-test.apache.org/
2. Open API: https://release-test.apache.org/api/docs
3. Comparison: https://release-test.apache.org/about
1. ATR: https://releases.apache.org
2. Docs: https://releases.apache.org/docs
3. Open API: https://releases.apache.org/api/docs
4. Catalog: https://release-catalog.apache.org

#### Source code

Expand All @@ -54,3 +48,10 @@ Here are the source code repositories. Please view the README.md files for instr
### Security Issues

To report a new vulnerability you have discovered please follow the [ASF vulnerability reporting process](https://apache.org/security/#reporting-a-vulnerability).

### Contribute to the Discussion

- Repository: https://github.com/apache/tooling-docs
- ASF Slack Channels: [#tooling-discuss](https://the-asf.slack.com/archives/C086X8CKEMB) – [#apache-trusted-releases](https://the-asf.slack.com/archives/C049WADAAQG)
- Mailing List: dev@tooling.apache.org – [archives](https://lists.apache.org/list.html?dev@tooling.apache.org)
- Subscribe to Mailing List: dev-subscribe@tooling.apache.org
93 changes: 73 additions & 20 deletions content/pages/trusted-releases.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,86 @@
Title: Apache Trusted Releases platform
license: https://www.apache.org/licenses/LICENSE-2.0

The main project is the Apache Trusted Releases platform.
The main project for the Tooling Initiative is the Apache Trusted Releases platform.

Repositories:
1. Websites:

- https://github.com/apache/tooling-trusted-releases
- https://github.com/apache/tooling-releases-client
- https://releases.apache.org - this is the ATR UX which is dynamic requiring ASF login credentials.
- https://release-catalog.apache.org - this is the full ASF release catalog in a static website hosted by httpd.

## 1. Automate the Release Process
2. Repositories:

- Minimize human interaction.
- Community participation on **Release Votes** remains via email.
- Record all of the key events and metrics for tracking operations and performance.
- PMCs can quickly benefit.
- Infra costs and management complexity are decreased.
- https://github.com/apache/tooling-trusted-releases - the ATR UX and API.
- https://github.com/apache/tooling-releases-client - a Python client for Release Managers.
- https://github.com/apache/tooling-actions - Github Actions for Trusted Publishing.

## 2. Community
## Beta platform features

- Work with a selection of **Apache** PMCs, **Incubator PPMCs(podlings)**, and **Infra** for **User Acceptance Testing (UAT)**.
- Co-ordinate with **Infra** on migration and operation.
- Contribute to Infra's **asfquart** and **asfpy** frameworks.
- Provide openings for volunteers to help so long as the contributions are adequate and timely.
- Assure that the **ATR platform** follows industry best practices especially regarding **SBOMs**,
**Certificate Management**, and **Digital Signatures**.
- Help lead the industry to better practices.
- Work within the **ASF** on **Release Policy** improvements.
- Minimize human interaction
- Easily follow release policy
- Require MFA for access
- Designate Release Managers and maintain their GPG public signing keys
- Confirm the derived release catalog and properly configure sub-projects
- Securely compose Release Candidates
- Enforce vote standards while continuing to include community
- Releases are still delivered to `svn:dist:release`
- Legacy release awareness in building a full release catalog.
- Expedited security releases are completely private
- Templated vote and announcement emails

## 3. Apache Trusted Release Platform (ATR)
## Configuration

The Apache Trusted Releases (ATR) platform makes a distinction between the two parts of a Project Management Committee.
First the PMC is a management committee with associated committers. Second, the PMC manages one or more projects.
To start to use ATR for your releases there is PMC configuration to review and adjust.

### Committee

For the Committee ATR tracks Projects, Release Managers, and Signing Keys.
The committee consists of the PMC Members and includes project committers by reference.
All PMC Members are enabled to be Release Managers. A PMC Member can designate any committer as a Release Manager.

The committee also has an associated set of GPG signing keys found in `svn:dist:release` by convention.
ATR can be configured to maintain the KEYS file for you.

Committees that are approved for CI Release builds require special setup. Permissions are shown on the committee page.
Look into [Tooling actions](https://github.com/apache/tooling-actions) for Github Actions to use for
[Trusted Publishing](https://releases.apache.org/docs/trusted-publishing).

### Projects

Most PMCs have only their namesake project. There are many projects that have 2-8 subprojects and there are a few
that have dozens of subprojects. We've determined subprojects via two methods. First via an existing DOAP file
known to https://projects.apache.org, and second by analyzing all existing and archived releases.
This process was imperfect and we require PMCs with multiple projects to correct and confirm these. The best place to verify projects is
by reviewing the PMC's catalog page at https://release-catalog.apache.org/. Engage with the Tooling team
to make corrections.

There are many different project settings. These are categorized according to their aspect.

1. Releases - start a new release version and view the project's current releases.
2. Metadata - the project name, description, and other urls. Some of these are required.
3. Security - security emails and threat model urls.
4. Lifecycle - how the project handles versioning. `semver`, `calver`, or `simple`.
5. Trusted Publishing - what GitHub repositories, branch, and workflows to trust.
6. Compose - license checking and other composition settings.
7. Vote - voting options and email templates.
8. Finish - distribution subdirectory and announcement email templates.

You can review these in the ATR website and then export a yaml fragment to save it in your project repository's `.asf.yaml` file.

### Release Managers

Each Release Manager should manage their access tokens and keys. At a minimum new Release Managers will need to save their GPG public key.
Depending on the method chosen to upload your release candidate artifacts PATs, JWTs, or SSH keys may be required.

## Release Candidate Phases

ATR has three phases for a Release Candidate. The Release Manager will guide the Candidate through these phases.

1. Compose - this phase starts when a new release version is created. Every artifact is checked in several ways. New revisions may be made,
2. Vote - this phase provides a supervised voting period and a public view of the candidate artifacts and check results.
3. Finish - this phase allows for the distribution of the release and ends with the announcement.

- Incorporate all PMC Releases.
- Download page.
Expand Down
5 changes: 5 additions & 0 deletions content/pages/volunteer.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,10 @@ There are some basic things you could do if you're going to help out with the AS
- Work on documentation.
- Discuss policy clarifications and other difficult issues including moving questions and proposals to the appropriate place.

We also have some tools under development that are volunteer led.

- A Maven plugin to help with starting an ATR release. This is a Java project from several Maven PMC Members.
- A Responsible AI service for distributing and metering LLM use. Called **LLM-A-O**.

**Come talk to us on [Slack](https://the-asf.slack.com/) in the
[#tooling-discuss](https://the-asf.slack.com/archives/C086X8CKEMB) channel!**
11 changes: 7 additions & 4 deletions content/theme/templates/menu.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,19 @@
<li class="nav-item dropdown">
<a class="nav-link dropdown-toggle" href="#" data-bs-toggle="dropdown" aria-expanded="false">Tools</a>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="https://release-test.apache.org/">Trusted Releases Alpha</a></li>
<li><a class="dropdown-item" href="https://releases.apache.org/">Trusted Releases Beta</a></li>
<li><a class="dropdown-item" href="https://release-catalog.apache.org/">Release Catalog</a></li>
<li><a class="dropdown-item" href="https://agenda.apache.org">Board Agenda Tool</a></li>
</ul>
</li>
<li class="nav-item dropdown">
<a class="nav-link dropdown-toggle" href="#" data-bs-toggle="dropdown" aria-expanded="false">Docs</a>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="https://release-test.apache.org/docs/">Trusted Releases</a></li>
<li><a class="dropdown-item" href="https://release-test.apache.org/api/docs">ATR Open API</a></li>
<li><a class="dropdown-item" href="/atr/maven/">ATR Maven Plugin</a></li>
<li><a class="dropdown-item" href="https://releases.apache.org/docs/">Trusted Releases</a></li>
<li><a class="dropdown-item" href="https://releases.apache.org/api/docs">ATR Open API</a></li>
<li><a class="dropdown-item" href="https://apache.github.io/tooling-atr-maven-plugin/">ATR Maven Plugin</a></li>
<li><hr class="dropdown-divider"></li>
<li><a class="dropdown-item" href="/atr-design-doc.html">Trusted Releases Design Doc</a></li>
</ul>
</li>
<li class="nav-item dropdown">
Expand Down
Loading