Skip to content

Commit 5c0dd9c

Browse files
authored
fix(docs): Fix some minor typos (#234)
1 parent 7078216 commit 5c0dd9c

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ jobs:
9696
with:
9797
application_id: ${{ secrets.AUTHENTICATOR_APPLICATION_ID }}
9898
application_private_key: ${{ secrets.AUTHENTICATOR_APPLICATION_PRIVATE_KEY }}
99-
organization: CattleDip
99+
organisation: CattleDip
100100

101101
- name: Use Application Token to checkout a repository
102102
uses: actions/checkout@v4
@@ -173,7 +173,7 @@ The important configuration details for the application are:
173173
- `Homepage URL` needs to be set to something as long as it is a URL
174174
- `Expire user authorization tokens` should be checked so as to expire any tokens that are issued
175175
- `Webhook` `Active` checkbox should be unchecked
176-
- `Repository permissions`, `Organization permissions` and/or `User permissions` allows the access required for the token that will be issued
176+
- `Repository permissions`, `Organisation permissions` and/or `User permissions` allows the access required for the token that will be issued
177177
- `Where can this GitHub App be installed?` should be scoped to your desired audience (the current account, or any account)
178178

179179
Once the application has been created you will be taken to the `General` settings page for the new application.
@@ -188,11 +188,11 @@ _Note: the private keys can and should be rotated periodically to limit the risk
188188

189189
#### Install the GitHub Application
190190

191-
Once you have the GitHub Application defined, you will need to install the application on the target organization or repository/
191+
Once you have the GitHub Application defined, you will need to install the application on the target organisation or repository/
192192
repositories that you want it to have access to. These will be any repositories that you want to gather information
193193
from or want the application to modify as per the scopes that were defined when the application was installed.
194194

195-
_Note: The GitHub Application will need to be installed on the organization and or repository that you are executing
195+
_Note: The GitHub Application will need to be installed on the organisation and or repository that you are executing
196196
the GitHub Actions workflow from, as the implementation requires this to be able to generate the access tokens_.
197197

198198
## Contributions
@@ -208,7 +208,7 @@ First set the following environment variables:
208208

209209
and either:
210210

211-
- `GITHUB_ORGANIZATION` - The GitHub Organisation to get the application installation for, if not specified will use the current repository instead
211+
- `GITHUB_ORG` - The GitHub Organisation to get the application installation for, if not specified will use the current repository instead
212212
or
213213
- `GITHUB_REPOSITORY_OWNER` - The GitHub Repository Owner to get the application installation for, if not specified will use the current repository instead
214214

@@ -217,8 +217,7 @@ e.g:
217217
```shell
218218
export GITHUB_APPLICATION_PRIVATE_KEY='-----BEGIN RSA PRIVATE KEY-----\\n<your private key>\\n-----END RSA PRIVATE KEY-----'
219219
export GITHUB_APPLICATION_ID=<applicationId>
220-
export GITHUB_ORGANIZATION=<organisation>
221-
export GITHUB_REPOSITORY_OWNER=<owner>
220+
export GITHUB_APPLICATION_ORG=<organisation>
222221
```
223222

224223
Then run the following commands:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "github-app-installation-token",
3-
"version": "2.0.0",
3+
"version": "2.1.1",
44
"keywords": [
55
"github-actions",
66
"github",

0 commit comments

Comments
 (0)