Página Inicial>Relacionado com a programação>Outro código-fonte
Baixar

Criar token de aplicativo GitHub

Ação GitHub para criar um token de acesso à instalação do aplicativo GitHub.

Uso

Para usar esta ação, você precisa:

  1. Registre um novo aplicativo GitHub
  2. Armazene o ID do aplicativo nas variáveis ​​de ambiente do seu repositório (exemplo: APP_ID )
  3. Armazene a chave privada do aplicativo nos segredos do seu repositório (exemplo: PRIVATE_KEY )

Importante

Um token de acesso à instalação expira após 1 hora. Consulte este comentário para abordagens alternativas se você tiver processos de longa execução.

Crie um token para o repositório atual 

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

Use token de aplicativo com 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 }}

Crie uma string de committer git para uma instalação de aplicativo 

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

Configure o git CLI para o usuário bot de um aplicativo 

 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

Dica

O <BOT USER ID> é o ID numérico do usuário bot do aplicativo, que pode ser encontrado em https://api.github.com/users/<app-slug>%5Bbot%5D .

Por exemplo, podemos verificar em https://api.github.com/users/dependabot[bot] para ver se o ID do usuário do Dependabot é 49699333.

Alternativamente, você pode usar octokit/request-action para obter o ID.

Crie um token para todos os repositórios na instalação do proprietário atual 

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

Crie um token para vários repositórios na instalação do proprietário atual 

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

Crie um token para todos os repositórios na instalação de outro proprietário 

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

Crie tokens para várias contas de usuário ou organização

Você pode usar uma estratégia de matriz para criar tokens para diversas contas de usuário ou organização.

Observação

Consulte esta documentação para obter informações sobre o uso de strings multilinhas em fluxos de trabalho. 

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

Execute o fluxo de trabalho em um repositório github.com em uma organização no 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 }}

Entradas

app-id

Obrigatório: ID do aplicativo GitHub.

private-key

Obrigatório: chave privada do aplicativo GitHub. Novas linhas com escape ( \n ) serão automaticamente substituídas por novas linhas reais.

Algumas outras ações podem exigir que a chave privada seja codificada em Base64. Para evitar a recriação de um novo segredo, ele pode ser decodificado instantaneamente, mas precisa ser gerenciado com segurança. Aqui está um exemplo de como isso pode ser alcançado: 

 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

Opcional: o proprietário da instalação do aplicativo GitHub. Se estiver vazio, o padrão é o proprietário atual do repositório.

repositories

Opcional: lista de repositórios separados por vírgula ou nova linha aos quais conceder acesso.

Observação

Se owner estiver definido e repositories estiverem vazios, o acesso terá como escopo todos os repositórios na instalação do proprietário do repositório fornecido. Se owner e repositories estiverem vazios, o acesso terá como escopo apenas o repositório atual.

skip-token-revoke

Opcional: Se for verdade, o token não será revogado quando o trabalho atual for concluído.

github-api-url

Opcional: a URL da API REST do GitHub. O padrão é a URL da API GitHub Rest de onde o fluxo de trabalho é executado.

Resultados

token

Token de acesso de instalação do aplicativo GitHub.

installation-id

ID de instalação do aplicativo GitHub.

app-slug

Slug do aplicativo GitHub.

Como funciona

A ação cria um token de acesso de instalação usando o endpoint POST /app/installations/{installation_id}/access_tokens . Por padrão,

  1. O token tem como escopo o repositório ou repositories atuais, se definido.
  2. O token herda todas as permissões da instalação.
  3. O token é definido como token de saída que pode ser usado nas etapas subsequentes.
  4. A menos que a entrada skip-token-revoke seja definida como um valor verdadeiro, o token será revogado na etapa post da ação, o que significa que não pode ser passado para outro trabalho.
  5. O token está mascarado e não pode ser registrado acidentalmente.

Observação

As permissões de instalação podem ser diferentes das permissões do aplicativo ao qual pertencem. As permissões de instalação são definidas quando um aplicativo é instalado em uma conta. Quando o aplicativo adiciona mais permissões após a instalação, um administrador da conta terá que aprovar as novas permissões antes de serem definidas na instalação.

Licença

MIT

Expandir
Informações adicionais
Aplicativos Relacionados
Recomendado para você
Informações Relacionadas Todos