Skip to content

Commit 235f423

Browse files
committed
Update README.md to use the wording proposed by @Jai-76
1 parent b7e972c commit 235f423

1 file changed

Lines changed: 36 additions & 6 deletions

File tree

README.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,45 @@
11
# ASF Tooling Actions
22

3-
This is the repository for GitHub Actions written and maintained by the Apache Software Foundation (ASF) Tooling team. Please note that ASF Tooling is an operational team, and, unlike Project Management Committees (PMCs), it does **not** make Board approved releases. You may also be looking for [ASF Infrastructure Actions](https://github.com/apache/infrastructure-actions) instead.
3+
This repository contains GitHub Actions written and maintained by the **Apache Software Foundation (ASF) Tooling team**.
44

5-
## Available actions
5+
**Note:** ASF Tooling is an operational team. Unlike Project Management Committees (PMCs), we do not make Board-approved releases.
66

7-
**NOTE: We do not tag versions. You must refer to every action by its pinned commit hash.**
7+
If you are looking for infrastructure-related actions, please visit [ASF Infrastructure Actions](https://github.com/apache/infrastructure-actions) instead.
8+
9+
## Versioning Policy
10+
11+
**We do not tag versions.** For security and stability, you must refer to every action by its **pinned commit hash** (SHA). Do not use `@main` or `@v1`.
12+
13+
## Available Actions
814

915
### `apache/tooling-actions/upload-to-atr`
1016

11-
[Upload your artifacts to ATR using OIDC and an ephemeral SSH key.](https://github.com/apache/tooling-actions/tree/main/upload-to-atr)
17+
![Status: Experimental](https://img.shields.io/badge/Status-EXPERIMENTAL-orange)
18+
19+
Upload your artifacts to the Apache Trusted Release (ATR) system using OIDC and an ephemeral SSH key.
20+
21+
#### Who is this for?
22+
23+
If you are a PMC Release Manager testing the ATR, we need your help testing this action. Please report any issues you encounter.
24+
25+
#### Usage Example
26+
27+
Add the following to your workflow `.yml` file. Ensure you replace `<COMMIT_HASH>` with the full SHA of the specific commit you wish to use.
1228

13-
Status: EXPERIMENTAL
29+
```yaml
30+
jobs:
31+
release:
32+
runs-on: ubuntu-latest
33+
permissions:
34+
id-token: write # Required for OIDC
35+
contents: read
36+
steps:
37+
- name: Checkout code
38+
uses: actions/checkout@<COMMIT_HASH>
1439

15-
If you are a PMC release manager testing the ATR, please help us to test this action.
40+
- name: Upload to ATR
41+
uses: apache/tooling-actions/upload-to-atr@<COMMIT_HASH>
42+
with:
43+
# Add specific inputs here that are required by the action
44+
# project: example
45+
# version: ${{ github.ref_name }}

0 commit comments

Comments
 (0)