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 acdeb06 Improve the documentation
acdeb06 is described below
commit acdeb068dcb8f38363d48afff31b486ef55a2c7f
Author: Sean B. Palmer <[email protected]>
AuthorDate: Fri Aug 22 15:35:53 2025 +0100
Improve the documentation
---
README.md | 4 +++-
upload-to-atr/README.md | 8 ++++----
2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index eced94c..b7c12fb 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# 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, it does **not**
make Board approved releases. You may also be looking for [ASF Infrastructure
Actions](https://github.com/apache/infrastructure-actions) instead.
+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.
## Available actions
@@ -9,3 +9,5 @@ This is the repository for GitHub Actions written and
maintained by the Apache S
[Upload your artifacts to ATR using OIDC and an emphemeral SSH
key.](https://github.com/apache/tooling-actions/tree/main/upload-to-atr)
Status: EXPERIMENTAL
+
+If you are a PMC release manager testing the ATR, please help us to test this
action.
diff --git a/upload-to-atr/README.md b/upload-to-atr/README.md
index 5f289ed..d2916c1 100644
--- a/upload-to-atr/README.md
+++ b/upload-to-atr/README.md
@@ -1,10 +1,10 @@
-### Upload to ATR with GitHub OIDC and rsync
+# Upload to ATR with GitHub OIDC and rsync
This composite GitHub Action exchanges a GitHub OIDC token for an ATR JWT,
registers a short lived SSH key, and rsyncs a local directory to ATR at
`/<project>/<version>/`. Use it to publish build artifacts to ATR without long
lived credentials.
Status: EXPERIMENTAL
-### Inputs
+## Inputs
- **asf-uid (required)**: Your ASF UID used for SSH login.
- **project (required)**: Project name segment in the remote path.
@@ -15,7 +15,7 @@ Status: EXPERIMENTAL
- **ssh-port**: SSH port on ATR. Default: `2222`.
- **rsync-args**: Arguments passed to `rsync`. Default: `-av`.
-### Example workflow
+## Example workflow
The `id-token` write permission is **required** when using this GitHub Action.
@@ -51,7 +51,7 @@ jobs:
rsync-args: -av
```
-### Further details
+## Further details
The job must grant `id-token: write` so that this action can request a GitHub
OIDC token.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
