You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This GitHub Action can be used to impersonate a GitHub App when `secrets.GITHUB_TOKEN`'s limitations are too restrictive and a personal access token is not suitable.
4
15
@@ -8,7 +19,7 @@ We can also use an app token to [custom an action's name and avatar](https://git
Before staring, we should get our owned app's _"APP ID"_ and _"Private Key"_ in the app's setting page. For example, find the two values in my app's setting page [https://github.com/settings/apps/wow-actions-bot](https://github.com/settings/apps/wow-actions-bot).
14
25
@@ -102,21 +113,21 @@ jobs:
102
113
GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}
103
114
```
104
115
105
-
### Inputs
116
+
### ๐๏ธ Inputs
106
117
107
118
Various inputs are defined to let you configure the action:
108
119
109
120
> Note: [Workflow command and parameter names are not case-sensitive](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#about-workflow-commands).
110
121
111
122
| Name | Description | Default |
112
-
| --- | --- | --- |
113
-
| `app_id` | The ID of the GitHub App. [Create an secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) named `'APP_ID'` to store your app ID, then used by `${{ secrets.APP_ID }}` | |
114
-
| `private_key` | The private key of the GitHub App (can be Base64 encoded). [Create an secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) named `'PRIVATE_KEY'` to store your app private key, then used by `${{ secrets.APP_ID }}` | |
123
+
| --- | --- | :-: |
124
+
| `app_id` | The ID of the GitHub App. [Create an secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) named `'APP_ID'` to store your app ID, then used by `${{ secrets.APP_ID }}` | N/A |
125
+
| `private_key` | The private key of the GitHub App (can be Base64 encoded). [Create an secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) named `'PRIVATE_KEY'` to store your app private key, then used by `${{ secrets.APP_ID }}` | N/A |
115
126
| `fallback` | The fallback token when app token generate failed | |
116
127
| `env_name` | The name of generated token in exported environment variable. Specify a varable name will set an environment variable with specfiied name and valued with generated token, and can be use in next step with `${{ env.env_name }}` | |
117
128
| `secret_name` | The name of the secret created on current repository. Specify a secret name will add an secret on current repository with specfiied name and valued with generated token and can be use in next step with `${{ secrets.xxx }}` | |
118
129
| `clean_secret` | Shoule clean the secret or not when the job completed. Only used when `secret_name` specfiied | `false` |
119
130
120
-
## License
131
+
## โ๏ธ License
121
132
122
133
The scripts and documentation in this project are released under the [MIT License](LICENSE)
0 commit comments