Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
Signed-off-by: Jason Hall <[email protected]>
  • Loading branch information
imjasonh committed Jan 28, 2024
1 parent 78e7302 commit 9b7c7df
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `octo-sts`
# `octo-sts-action`

This action federates the Github actions identity token for a Github App token
This action federates the GitHub Actions identity token for a Github App token
according to the Trust Policy in the target organization or repository.

## Usage
Expand All @@ -10,20 +10,14 @@ permissions:
id-token: write # Needed to federate tokens.

steps:
- uses: chainguard-dev/actions/octo-sts@main
- uses: chainguard-dev/octo-sts-action@main
id: octo-sts
with:
# environment determines the environment from which to download the chainctl
# binary from.
# Optional (default is enforce.dev)
scope: your-org/your-repo

# identity holds the ID for the identity this workload should assume when
# speaking to Chainguard APIs.
identity: foo

- env:
GH_TOKEN: ${{ steps.octo-sts.outputs.token }}
GITHUB_TOKEN: ${{ steps.octo-sts.outputs.token }}
run: |
gh repo list
```
Expand All @@ -41,3 +35,5 @@ permissions:
contents: read
issues: write
```

See the [Use Action](./.github/workflows/use-action.yaml) workflow for a working example of this, that opens an issue in this repository.

0 comments on commit 9b7c7df

Please sign in to comment.