You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tooling.apache.org by sb...@apache.org on 2026/01/14 15:39:22 UTC

(tooling-actions) branch main updated: Update README.md to use the wording proposed by @Jai-76

This is an automated email from the ASF dual-hosted git repository.

sbp pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-actions.git


The following commit(s) were added to refs/heads/main by this push:
     new 235f423  Update README.md to use the wording proposed by @Jai-76
235f423 is described below

commit 235f423de6d7d9599129a2681e0ae61a796f52fb
Author: Sean B. Palmer <se...@miscoranda.com>
AuthorDate: Wed Jan 14 15:39:02 2026 +0000

    Update README.md to use the wording proposed by @Jai-76
---
 README.md | 42 ++++++++++++++++++++++++++++++++++++------
 1 file changed, 36 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index b6eb1f4..4bdb857 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,45 @@
 # ASF Tooling Actions
 
-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.
+This repository contains GitHub Actions written and maintained by the **Apache Software Foundation (ASF) Tooling team**.
 
-## Available actions
+**Note:** ASF Tooling is an operational team. Unlike Project Management Committees (PMCs), we do not make Board-approved releases.
 
-**NOTE: We do not tag versions. You must refer to every action by its pinned commit hash.**
+If you are looking for infrastructure-related actions, please visit [ASF Infrastructure Actions](https://github.com/apache/infrastructure-actions) instead.
+
+## Versioning Policy
+
+**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`.
+
+## Available Actions
 
 ### `apache/tooling-actions/upload-to-atr`
 
-[Upload your artifacts to ATR using OIDC and an ephemeral SSH key.](https://github.com/apache/tooling-actions/tree/main/upload-to-atr)
+![Status: Experimental](https://img.shields.io/badge/Status-EXPERIMENTAL-orange)
+
+Upload your artifacts to the Apache Trusted Release (ATR) system using OIDC and an ephemeral SSH key.
+
+#### Who is this for?
+
+If you are a PMC Release Manager testing the ATR, we need your help testing this action. Please report any issues you encounter.
+
+#### Usage Example
+
+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.
 
-Status: EXPERIMENTAL
+```yaml
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write # Required for OIDC
+      contents: read
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@<COMMIT_HASH>
 
-If you are a PMC release manager testing the ATR, please help us to test this action.
+      - name: Upload to ATR
+        uses: apache/tooling-actions/upload-to-atr@<COMMIT_HASH>
+        with:
+          # Add specific inputs here that are required by the action
+          # project: example
+          # version: ${{ github.ref_name }}


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@tooling.apache.org
For additional commands, e-mail: commits-help@tooling.apache.org