Beranda>Terkait pemrograman>Kode sumber lainnya
Unduh

Buat Token Aplikasi GitHub

Tindakan GitHub untuk membuat token akses instalasi Aplikasi GitHub.

Penggunaan

Untuk menggunakan tindakan ini, Anda perlu:

  1. Daftarkan Aplikasi GitHub baru
  2. Simpan ID Aplikasi di variabel lingkungan repositori Anda (contoh: APP_ID )
  3. Simpan kunci pribadi Aplikasi di rahasia repositori Anda (contoh: PRIVATE_KEY )

Penting

Token akses instalasi akan kedaluwarsa setelah 1 jam. Silakan lihat komentar ini untuk pendekatan alternatif jika Anda memiliki proses yang berjalan lama.

Buat token untuk repositori saat ini 

 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 }}

Gunakan token aplikasi dengan 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 }}

Buat string git committer untuk instalasi aplikasi 

 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 }}"

Konfigurasikan git CLI untuk pengguna bot aplikasi 

 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

Tip

<BOT USER ID> adalah ID pengguna numerik dari pengguna bot aplikasi, yang dapat ditemukan di https://api.github.com/users/<app-slug>%5Bbot%5D .

Misalnya, kita dapat memeriksa di https://api.github.com/users/dependabot[bot] untuk melihat ID pengguna Dependabot adalah 49699333.

Alternatifnya, Anda dapat menggunakan octokit/request-action untuk mendapatkan ID.

Buat token untuk semua repositori di instalasi pemilik saat ini 

 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! "

Buat token untuk beberapa repositori di instalasi pemilik saat ini 

 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! "

Buat token untuk semua repositori di instalasi pemilik lain 

 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! "

Buat token untuk beberapa akun pengguna atau organisasi

Anda dapat menggunakan strategi matriks untuk membuat token untuk beberapa akun pengguna atau organisasi.

Catatan

Lihat dokumentasi ini untuk informasi tentang penggunaan string multiline dalam alur kerja. 

 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 }}

Jalankan alur kerja di repositori github.com terhadap organisasi di GitHub Enterprise Server 

 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 }}

Masukan

app-id

Diperlukan: ID Aplikasi GitHub.

private-key

Diperlukan: Kunci pribadi Aplikasi GitHub. Baris baru yang lolos ( \n ) akan otomatis diganti dengan baris baru yang sebenarnya.

Beberapa tindakan lain mungkin memerlukan kunci pribadi untuk dikodekan Base64. Untuk menghindari terciptanya kembali rahasia baru, rahasia tersebut dapat didekodekan dengan cepat, namun perlu dikelola dengan aman. Berikut adalah contoh bagaimana hal ini dapat dicapai: 

 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

Opsional: Pemilik instalasi Aplikasi GitHub. Jika kosong, defaultnya adalah pemilik repositori saat ini.

repositories

Opsional: Daftar repositori yang dipisahkan koma atau baris baru untuk diberikan akses.

Catatan

Jika owner disetel dan repositories kosong, akses akan dibatasi ke semua repositori dalam instalasi pemilik repositori yang disediakan. Jika owner dan repositories kosong, akses hanya akan dibatasi pada repositori saat ini.

skip-token-revoke

Opsional: Jika benar, token tidak akan dicabut ketika tugas saat ini selesai.

github-api-url

Opsional: URL GitHub REST API. Defaultnya adalah URL GitHub Rest API tempat alur kerja dijalankan.

Keluaran

token

Token akses instalasi Aplikasi GitHub.

installation-id

ID instalasi Aplikasi GitHub.

app-slug

Siput Aplikasi GitHub.

Bagaimana cara kerjanya

Tindakan ini membuat token akses instalasi menggunakan titik akhir POST /app/installations/{installation_id}/access_tokens . Secara default,

  1. Token dicakup ke repositori saat ini atau repositories jika disetel.
  2. Token mewarisi semua izin instalasi.
  3. Token ditetapkan sebagai token keluaran yang dapat digunakan pada langkah selanjutnya.
  4. Kecuali input skip-token-revoke diatur ke nilai yang sebenarnya, token akan dicabut pada langkah post tindakan, yang berarti token tidak dapat diteruskan ke pekerjaan lain.
  5. Tokennya bertopeng, tidak dapat dicatat secara tidak sengaja.

Catatan

Izin penginstalan dapat berbeda dengan izin aplikasi yang dimilikinya. Izin instalasi diatur ketika aplikasi diinstal pada akun. Saat aplikasi menambahkan lebih banyak izin setelah penginstalan, administrator akun harus menyetujui izin baru sebelum izin tersebut ditetapkan pada penginstalan.

Lisensi

MIT

Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua