Skip to content

Commit 20ab010

Browse files
authored
Update README.md (#15)
1 parent 25f604f commit 20ab010

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,15 +70,15 @@ The simplest authentication method using username and password:
7070
space: myspace
7171
```
7272

73-
### JWT Bearer Token Grant with GitHub OIDC
73+
### JWT Bearer Token Grant
7474

75-
This method leverages GitHub's OIDC provider for secure, token-based authentication:
75+
This method leverages JWT Bearer token-based authentication:
7676

7777
```yaml
7878
name: JWT Bearer Flow using GitHub id_token
7979
on: [push]
8080
permissions:
81-
id-token: write # Required for requesting the JWT
81+
id-token: write # Required for requesting the GitHub JWT
8282
contents: read # Required for actions/checkout
8383
jobs:
8484
deploy:
@@ -89,6 +89,7 @@ jobs:
8989
with:
9090
api: ${{ secrets.CF_API }}
9191
grant_type: jwt-bearer
92+
jwt: ${{ secrets.JWT }} # can be omitted when using GitHub id token
9293
org: test
9394
space: dev
9495
- name: run cf command
@@ -103,8 +104,8 @@ This method uses client credentials with JWT verification:
103104
name: Client Credentials using GitHub id_token
104105
on: [push]
105106
permissions:
106-
id-token: write
107-
contents: read
107+
id-token: write # Required for requesting the GitHub JWT
108+
contents: read # Required for actions/checkout
108109
jobs:
109110
deploy:
110111
runs-on: ubuntu-latest

0 commit comments

Comments
 (0)