refactor: ♻️ inputs name

Author: bubkoo

.github/workflows/needs-more-info.yml

@@ -19,8 +19,8 @@ jobs:
         id: generate_token
         uses: ./
         with:
-          APP_ID: ${{ secrets.APP_ID }}
-          PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.PRIVATE_KEY }}
       - uses: bubkoo/needs-more-info@v1
         with:
           GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}

README.md

@@ -4,9 +4,21 @@ This GitHub Action can be used to impersonate a GitHub App when `secrets.GITHUB_
 
 [`secrets.GITHUB_TOKEN`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) has limitations such as [not being able to triggering a new workflow from another workflow](https://github.community/t5/GitHub-Actions/Triggering-a-new-workflow-from-another-workflow/td-p/31676). A workaround is to use a [personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) from a [personal user/bot account](https://help.github.com/en/github/getting-started-with-github/types-of-github-accounts#personal-user-accounts). However, for organizations, GitHub Apps are [a more appropriate automation solution](https://developer.github.com/apps/differences-between-apps/#machine-vs-bot-accounts).
 
-## Example Workflow
+We can also use an app token to [custom an action's name and avatar](https://github.community/t/change-bots-name-avatar/18349).
+
+![all links](https://github.com/bubkoo/use-app-token/blob/master/screenshot.jpg?raw=true)
+
+## Usage
+
+Use action's output in other actions.
 
 ```yml
+name: Needs More Info
+on:
+  pull_request:
+    types: [opened]
+  issues:
+    types: [opened]
 jobs:
   run:
     runs-on: ubuntu-latest
@@ -15,8 +27,8 @@ jobs:
         id: generate_token
         uses: bubkoo/use-app-token@v1
         with:
-          APP_ID: ${{ secrets.APP_ID }}
-          PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.PRIVATE_KEY }}
       - name: Needs More info # Use token in other actions
         uses: bubkoo/needs-more-info@v1
         with:
@@ -25,13 +37,52 @@ jobs:
           CONFIG_FILE: .github/workflows/config/needs-more-info.yml
 ```
 
-### Options
+Or set an secret in you repo:
+
+```yml
+name: App Token
+on:
+  schedule:
+    - cron: '0 1 * * *'
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: bubkoo/use-app-token@v1
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.PRIVATE_KEY }}
+          # The secret name
+          secret_name: APP_TOKEN
+```
+
+Then we can use the secret named `'APP_TOKEN'` in other ancitons:
+
+```yml
+name: Needs More Info
+on:
+  pull_request:
+    types: [opened]
+  issues:
+    types: [opened]
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Needs More info
+        uses: bubkoo/needs-more-info@v1
+        with:
+          GITHUB_TOKEN: ${{ secrets.APP_TOKEN }}
+          CONFIG_FILE: .github/workflows/config/needs-more-info.yml
+```
+
+### Inputs
 
-- `APP_ID`: The ID of the GitHub App.
-- `PRIVATE_KEY`: The private key of the GitHub App (can be Base64 encoded).
-- `VARIABLE_NAME`: The name of generated token in exported 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 `${ VARIABLE_NAME }`.
-- `SECRET_NAME`: The secret name 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.SECRET_NAME }}`.
-- `CLEAN_SECRET`: Shoule clean the secret or not when the job completed. Only used when `SECRET_NAME` specfiied. Default `false`.
+- `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 }}`
+- `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 }}`
+- `variable_name`: The name of generated token in exported 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 `${ private_key }`.
+- `secret_name`: The secret name 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 }}`.
+- `clean_secret`: Shoule clean the secret or not when the job completed. Only used when `secret_name` specfiied. Default `false`.
 
 ## License
 

action.yml

@@ -1,31 +1,34 @@
 name: Use App token
-description: Run a GitHub Action as a GitHub App instead of using secrets.GITHUB_TOKEN or a personal access token.
+description: Run a GitHub Action as a GitHub App to use the app's token.
 author: bubkoo <[email protected]>
 inputs:
-  APP_ID:
+  app_id:
     description: The ID of the GitHub App.
     required: true
-  PRIVATE_KEY:
+  private_key:
     description: The private key of the GitHub App (can be Base64 encoded).
     required: true
-  VARIABLE_NAME:
+  variable_name:
     description: The name of generated token in output and exported variable.
     required: false
     default: token
-  SECRET_NAME:
+  secret_name:
     description: The secret name created on current repository.
     required: false
-  CLEAN_SECRET:
+  clean_secret:
     description: Shoule clean the secret or not when completed.
     required: false
     default: false
+
 outputs:
   token:
     description: An installation token for the GitHub App on the current repository.
+
 runs:
   using: node12
   main: dist/index.js
   post: dist/index.js
+
 branding:
   icon: anchor
   color: orange # gray-dark purple red orange green blue yellow black white

package.json

@@ -1,7 +1,7 @@
 {
   "name": "use-app-token",
-  "version": "1.0.0",
-  "description": "Run a GitHub Action as a GitHub App instead of using secrets.GITHUB_TOKEN or a personal access token.",
+  "version": "1.0.1",
+  "description": "Run a GitHub Action as a GitHub App to use the app's token.",
   "main": "dist/index.js",
   "files": [
     "dist",

screenshot.jpg

@@ -6,7 +6,8 @@ export namespace Action {
     try {
       const token = await Util.getAppToken()
       core.info('Token generated!')
-      const secretName = core.getInput('SECRET_NAME')
+
+      const secretName = core.getInput('secret_name')
       if (secretName) {
         await Util.saveAppTokenToSecret(secretName, token)
         core.info(`Token save in secret "${secretName}"`)
@@ -15,7 +16,7 @@ export namespace Action {
       core.setSecret(token)
       core.setOutput('token', token)
 
-      const variableName = core.getInput('VARIABLE_NAME')
+      const variableName = core.getInput('variable_name')
       if (variableName) {
         core.exportVariable(variableName, token)
       }
@@ -27,7 +28,7 @@ export namespace Action {
 
   export async function cleanup() {
     try {
-      const secretName = core.getInput('SECRET_NAME')
+      const secretName = core.getInput('secret_name')
       if (secretName) {
         await Util.removeAppTokenFromSecret(secretName)
         core.info(`Token in secret "${secretName}" was cleaned`)

src/action.ts

@@ -5,7 +5,7 @@ import { Action } from './action'
 if (!State.isPost) {
   Action.run()
 } else {
-  if (getInput('CLEAN_SECRET') === 'true') {
+  if (getInput('clean_secret') === 'true') {
     Action.cleanup()
   }
 }

src/index.ts

@@ -7,8 +7,8 @@ import sodium from 'tweetsodium'
 
 export namespace Util {
   export async function getAppToken() {
-    const id = Number(getInput('APP_ID', { required: true }))
-    const privateKeyInput = getInput('PRIVATE_KEY', { required: true })
+    const id = Number(getInput('app_id', { required: true }))
+    const privateKeyInput = getInput('private_key', { required: true })
     const privateKey = isBase64(privateKeyInput)
       ? Buffer.from(privateKeyInput, 'base64').toString('utf8')
       : privateKeyInput