From 950f8a0559e1549a299462ee101b77debd912167 Mon Sep 17 00:00:00 2001 From: Parker Brown <17183625+parkerbxyz@users.noreply.github.com> Date: Mon, 21 Aug 2023 14:31:57 -0700 Subject: [PATCH 1/2] docs(README): update title, description, formatting, and more (#11) - Update title - Remove blockquote formatting from description to improve accessibility - Capitalize "app" in "GitHub App" for consistency - Add missing periods in unordered list - Use new highlight syntax for note --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 40f57b9..9f467e2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# `actions/github-app-token` +# Create GitHub App Token -> GitHub Action for creating a GitHub App Installation Access Token +GitHub Action for creating a GitHub App installation access token. ## Usage @@ -61,29 +61,29 @@ jobs: ### `app_id` -**Required:** GitHub app ID. +**Required:** GitHub App ID. ### `private_key` -**Required:** GitHub app private key. +**Required:** GitHub App private key. ## Outputs ### `token` -GitHub installation access token. +GitHub App installation access token. ## How it works The action creates an installation access token using [the `POST /app/installations/{installation_id}/access_tokens` endpoint](https://docs.github.com/rest/apps/apps?apiVersion=2022-11-28#create-an-installation-access-token-for-an-app). By default, -1. The token is scoped to the current repository -2. The token inherits all the installation's permissions -3. The token is set as output `token` which can be used in subsequent steps +1. The token is scoped to the current repository. +2. The token inherits all the installation's permissions. +3. The token is set as output `token` which can be used in subsequent steps. 4. The token is revoked in the `post` step of the action, which means it cannot be passed to another job. 5. The token is masked, it cannot be logged accidentally. That is not a feature by the action, but by the GitHub Actions runner itself, due to the specific format of GitHub tokens. -> **Note** +> [!NOTE] > Installation permissions can differ from the app's permissions they belong to. Installation permissions are set when an app is installed on an account. When the app adds more permissions after the installation, an account administrator will have to approve the new permissions before they are set on the installation. ## License From 12aa81137bd7fec724cf23ab0c54092261f59830 Mon Sep 17 00:00:00 2001 From: Gregor Martynus <39992+gr2m@users.noreply.github.com> Date: Mon, 21 Aug 2023 14:32:39 -0700 Subject: [PATCH 2/2] fix(action-config): prepare for release to marketplace (#10) https://github.com/marketplace/actions/github-app-token is taken, hence the rename --------- Co-authored-by: Parker Brown <17183625+parkerbxyz@users.noreply.github.com> --- action.yml | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/action.yml b/action.yml index d7eda94..2488d8d 100644 --- a/action.yml +++ b/action.yml @@ -1,17 +1,20 @@ -name: 'github-app-token' -description: '' -author: 'Gregor Martynus and Parker Brown' +name: "Create GitHub App Token" +description: "GitHub Action for creating a GitHub App installation access token" +author: "Gregor Martynus and Parker Brown" +branding: + icon: "lock" + color: "gray-dark" inputs: app_id: - description: 'GitHub app ID' + description: "GitHub App ID" required: true private_key: - description: 'GitHub app private key' + description: "GitHub App private key" required: true outputs: token: - description: 'GitHub installation access token' + description: "GitHub installation access token" runs: - using: 'node16' - main: 'dist/main.cjs' - post: 'dist/post.cjs' + using: "node16" + main: "dist/main.cjs" + post: "dist/post.cjs"