From 48623f316d667c25ee1f7d2120d67848b04b679b Mon Sep 17 00:00:00 2001 From: Max Wagner Date: Tue, 12 Jul 2022 14:39:51 -0600 Subject: [PATCH] Update README example This updates the example to be exact about how to use the debugger. --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4bcf3ab..21c57a0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,10 @@ This action requests a JWT and prints the claims included within the JWT received from GitHub Actions. -## Usage +## How to use this Action + +To use this Action in another repository, you must checkout this Action repo and then run it. +Here's an example of how that is done: ```yaml @@ -16,10 +19,15 @@ jobs: runs-on: ubuntu-latest name: A test of the oidc debugger steps: - - name: Checkout + - name: Checkout actions-oidc-debugger uses: actions/checkout@v3 + with: + repository: github/actions-oidc-debugger + ref: main + token: ${{ secrets.your-checkout-token }} + path: ./.github/actions/actions-oidc-debugger - name: Debug OIDC Claims - uses: github/actions-oidc-debugger@v1 + uses: ./.github/actions/actions-oidc-debugger with: - audience: 'https://github.com/github + audience: 'https://github.com/github' ```