create github app tokenダウンロード - create github app tokenソースコードのダウンロード

GitHub アプリトークンの作成

GitHub アプリのインストールアクセストークンを作成するための GitHub アクション。

使用法

このアクションを使用するには、次のことを行う必要があります。

新しい GitHub アプリを登録する
アプリの ID をリポジトリ環境変数に保存します (例: APP_ID )
アプリの秘密キーをリポジトリのシークレットに保存します (例: PRIVATE_KEY )

重要

インストールアクセストークンは 1 時間後に期限切れになります。実行時間が長いプロセスがある場合の代替アプローチについては、このコメントを参照してください。

現在のリポジトリのトークンを作成する

 name : Run tests on staging
on :
  push :
    branches :
      - main

jobs :
  hello-world :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
      - uses : ./actions/staging-tests
        with :
          token : ${{ steps.app-token.outputs.token }}

`actions/checkout`でアプリトークンを使用する

 on : [pull_request]

jobs :
  auto-format :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          # required
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
      - uses : actions/checkout@v4
        with :
          token : ${{ steps.app-token.outputs.token }}
          ref : ${{ github.head_ref }}
          # Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
          persist-credentials : false
      - uses : creyD/[email protected]
        with :
          github_token : ${{ steps.app-token.outputs.token }}

アプリのインストール用の git コミッター文字列を作成する

 on : [pull_request]

jobs :
  auto-format :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          # required
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
      - name : Get GitHub App User ID
        id : get-user-id
        run : echo "user-id=$(gh api "/users/${{ steps.app-token.outputs.app-slug }}[bot]" --jq .id)" >> "$GITHUB_OUTPUT"
        env :
          GH_TOKEN : ${{ steps.app-token.outputs.token }}
      - id : committer
        run : echo "string=${{ steps.app-token.outputs.app-slug }}[bot] <${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com>"  >> "$GITHUB_OUTPUT"
      - run : echo "committer string is ${ {steps.committer.outputs.string }}"

アプリのボットユーザー用に git CLI を構成する

 on : [pull_request]

jobs :
  auto-format :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          # required
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
      - name : Get GitHub App User ID
        id : get-user-id
        run : echo "user-id=$(gh api "/users/${{ steps.app-token.outputs.app-slug }}[bot]" --jq .id)" >> "$GITHUB_OUTPUT"
        env :
          GH_TOKEN : ${{ steps.app-token.outputs.token }}
      - run : |
          git config --global user.name '${{ steps.app-token.outputs.app-slug }}[bot]'
          git config --global user.email '${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com>'
      # git commands like commit work using the bot user
      - run : |
          git add .
          git commit -m "Auto-generated changes"
          git push

ヒント

<BOT USER ID>は、アプリのボットユーザーの数値ユーザー ID であり、 https://api.github.com/users/<app-slug>%5Bbot%5Dにあります。

たとえば、 https://api.github.com/users/dependabot[bot]で、Dependabot のユーザー ID が 49699333 であることを確認できます。

あるいは、octokit/request-action を使用して ID を取得することもできます。

現在の所有者のインストール内のすべてのリポジトリのトークンを作成します

 on : [workflow_dispatch]

jobs :
  hello-world :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
          owner : ${{ github.repository_owner }}
      - uses : peter-evans/create-or-update-comment@v3
        with :
          token : ${{ steps.app-token.outputs.token }}
          issue-number : ${{ github.event.issue.number }}
          body : " Hello, World! "

現在の所有者のインストールで複数のリポジトリのトークンを作成する

 on : [issues]

jobs :
  hello-world :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
          owner : ${{ github.repository_owner }}
          repositories : |
            repo1
            repo2
      - uses : peter-evans/create-or-update-comment@v3
        with :
          token : ${{ steps.app-token.outputs.token }}
          issue-number : ${{ github.event.issue.number }}
          body : " Hello, World! "

別の所有者のインストール内のすべてのリポジトリのトークンを作成する

 on : [issues]

jobs :
  hello-world :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
          owner : another-owner
      - uses : peter-evans/create-or-update-comment@v3
        with :
          token : ${{ steps.app-token.outputs.token }}
          issue-number : ${{ github.event.issue.number }}
          body : " Hello, World! "

複数のユーザーまたは組織アカウントのトークンを作成する

マトリックス戦略を使用して、複数のユーザーまたは組織アカウントのトークンを作成できます。

注記

ワークフローでの複数行の文字列の使用については、このドキュメントを参照してください。

 on : [workflow_dispatch]

jobs :
  set-matrix :
    runs-on : ubuntu-latest
    outputs :
      matrix : ${{ steps.set.outputs.matrix }}
    steps :
      - id : set
        run : echo 'matrix=[{"owner":"owner1"},{"owner":"owner2","repos":["repo1"]}]' >>"$GITHUB_OUTPUT"

  use-matrix :
    name : " @${{ matrix.owners-and-repos.owner }} installation "
    needs : [set-matrix]
    runs-on : ubuntu-latest
    strategy :
      matrix :
        owners-and-repos : ${{ fromJson(needs.set-matrix.outputs.matrix) }}

    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
          owner : ${{ matrix.owners-and-repos.owner }}
          repositories : ${{ join(matrix.owners-and-repos.repos) }}
      - uses : octokit/[email protected]
        id : get-installation-repositories
        with :
          route : GET /installation/repositories
        env :
          GITHUB_TOKEN : ${{ steps.app-token.outputs.token }}
      - run : echo "$MULTILINE_JSON_STRING"
        env :
          MULTILINE_JSON_STRING : ${{ steps.get-installation-repositories.outputs.data }}

GitHub Enterprise Server の組織に対して github.com リポジトリ内のワークフローを実行する

 on : [push]

jobs :
  create_issue :
    runs-on : self-hosted

    steps :
    - name : Create GitHub App token
      id : create_token
      uses : actions/create-github-app-token@v1
      with :
        app-id : ${{ vars.GHES_APP_ID }}
        private-key : ${{ secrets.GHES_APP_PRIVATE_KEY }}
        owner : ${{ vars.GHES_INSTALLATION_ORG }}
        github-api-url : ${{ vars.GITHUB_API_URL }}

    - name : Create issue
      uses : octokit/[email protected]
      with :
        route : POST /repos/${{ github.repository }}/issues
        title : " New issue from workflow "
        body : " This is a new issue created from a GitHub Action workflow. "
      env :
        GITHUB_TOKEN : ${{ steps.create_token.outputs.token }}

入力

`app-id`

必須: GitHub アプリ ID。

`private-key`

必須: GitHub アプリの秘密キー。エスケープされた改行 ( \n ) は、実際の改行に自動的に置き換えられます。

他の一部のアクションでは、秘密キーを Base64 でエンコードする必要がある場合があります。新しいシークレットの再作成を避けるために、その場でデコードできますが、安全に管理する必要があります。これを実現する方法の例を次に示します。

 steps :
  - name : Decode the GitHub App Private Key
    id : decode
    run : |
      private_key=$(echo "${{ secrets.PRIVATE_KEY }}" | base64 -d | awk 'BEGIN {ORS="\n"} {print}' | head -c -2) &> /dev/null
      echo "::add-mask::$private_key"
      echo "private-key=$private_key" >> "$GITHUB_OUTPUT"
  - name : Generate GitHub App Token
    id : app-token
    uses : actions/create-github-app-token@v1
    with :
      app-id : ${{ vars.APP_ID }}
      private-key : ${{ steps.decode.outputs.private-key }}

`owner`

オプション: GitHub アプリのインストールの所有者。空の場合、デフォルトは現在のリポジトリ所有者になります。

`repositories`

オプション:アクセスを許可するリポジトリのカンマまたは改行区切りのリスト。

注記

ownerが設定されており、 repositoriesが空の場合、アクセスの範囲は、指定されたリポジトリ所有者のインストール内のすべてのリポジトリに限定されます。 ownerとrepositoriesが空の場合、アクセスの範囲は現在のリポジトリのみに限定されます。

`skip-token-revoke`

オプション: true の場合、現在のジョブが完了してもトークンは取り消されません。

`github-api-url`

オプション: GitHub REST API の URL。デフォルトは、ワークフローの実行元となる GitHub Rest API の URL です。

出力

`token`

GitHub アプリのインストールアクセストークン。

`installation-id`

GitHub アプリのインストール ID。

`app-slug`

GitHub アプリのスラッグ。

仕組み

このアクションはPOST /app/installations/{installation_id}/access_tokensエンドポイントを使用してインストールアクセストークンを作成します。デフォルトでは、

トークンは、設定されている場合、現在のrepositoriesにスコープされます。
トークンは、インストールのすべての権限を継承します。
トークンは、後続のステップで使用できる出力tokenとして設定されます。
skip-token-revoke入力が真の値に設定されていない限り、トークンはアクションのpostステップで取り消されます。これは、トークンを別のジョブに渡すことができないことを意味します。
トークンはマスクされているため、誤ってログに記録されることはありません。

注記

インストール権限は、それらが属するアプリの権限とは異なる場合があります。インストール権限は、アプリがアカウントにインストールされるときに設定されます。インストール後にアプリがさらに権限を追加する場合、アカウント管理者は新しい権限をインストール時に設定する前に承認する必要があります。

ライセンス

マサチューセッツ工科大学

拡大する

create github app token

GitHub アプリトークンの作成

使用法

現在のリポジトリのトークンを作成する

`actions/checkout`でアプリトークンを使用する

アプリのインストール用の git コミッター文字列を作成する

アプリのボットユーザー用に git CLI を構成する

現在の所有者のインストール内のすべてのリポジトリのトークンを作成します

現在の所有者のインストールで複数のリポジトリのトークンを作成する

別の所有者のインストール内のすべてのリポジトリのトークンを作成する

複数のユーザーまたは組織アカウントのトークンを作成する

GitHub Enterprise Server の組織に対して github.com リポジトリ内のワークフローを実行する

入力

`app-id`

`private-key`

`owner`

`repositories`

`skip-token-revoke`

`github-api-url`

出力

`token`

`installation-id`

`app-slug`

仕組み

ライセンス

GitHub sgrebnov/cordova plugin background download

GitHub actions/download artifact

GitHub anfreire/updateMe Mobile

GitHub the via/releases

GitHub デスクトップオフラインパッケージ 2.1.0

github ページブログシステム v1.0

chat.petals.dev

GPT Prompt Templates

GPTyped

waymo open dataset

SmartTube

Sunamu

wp functions

waymo open dataset

slugify

create github app token

GitHub アプリトークンの作成

使用法

現在のリポジトリのトークンを作成する

actions/checkoutでアプリトークンを使用する

アプリのインストール用の git コミッター文字列を作成する

アプリのボット ユーザー用に git CLI を構成する

現在の所有者のインストール内のすべてのリポジトリのトークンを作成します

現在の所有者のインストールで複数のリポジトリのトークンを作成する

別の所有者のインストール内のすべてのリポジトリのトークンを作成する

複数のユーザーまたは組織アカウントのトークンを作成する

GitHub Enterprise Server の組織に対して github.com リポジトリ内のワークフローを実行する

入力

app-id

private-key

owner

repositories

skip-token-revoke

github-api-url

出力

token

installation-id

app-slug

仕組み

ライセンス

`actions/checkout`でアプリトークンを使用する

アプリのボットユーザー用に git CLI を構成する

`app-id`

`private-key`

`owner`

`repositories`

`skip-token-revoke`

`github-api-url`

`token`

`installation-id`

`app-slug`