Usar anexos de conteúdo

Etapa 3. Seu aplicativo receberá o content_reference webhook com a ação criada.

{
  "action": "created",
  "content_reference": {
    "id": 17,
    "node_id": "MDE2OkNvbnRlbnRSZWZlcmVuY2UxNjA5",
    "reference": "errors.ai"
  },
  "repository": {
    "full_name": "Codertocat/Hello-World",
  },
  "sender": {...},
  "installation": {
    "id": 371641,
    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzcxNjQx"
  }
}

Etapa 4. O aplicativo usa os campos content_reference id e repositório full_name para Criar um anexo de conteúdo usando a API REST. Você também precisará do id da instalação para efetuar a autenticação como uma instalação do aplicativo GitHub.

application/vnd.github.corsair-preview+json

O parâmetro do texto pode conter markdown:

<pre><code class="hljs language-shell">curl -X POST \
  https://api.github.com/repos/Codertocat/Hello-World/content_references/17/attachments \
  -H 'Accept: application/vnd.github.corsair-preview+json' \
  -H 'Authorization: Bearer $INSTALLATION_TOKEN' \
  -d '{
    "title": "[A-1234] Error found in core/models.py file",
    "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()"
}'</code></pre>

Para obter mais informações sobre a criação de um token de instalação, consulte "Efetuando a autenticação como um aplicativo GitHub".

Etapa 5. Você verá o novo anexo de conteúdo aparecer no link de um pull request ou comentário de um problema:

Usar anexos de conteúdo no GraphQL

Nós fornecemos o node_id no evento content_reference webhook para que você possa fazer referência à mutação createContentAttachment na API do GraphQL.

application/vnd.github.corsair-preview+json

Por exemplo:

mutation {
  createContentAttachment(input: {
    contentReferenceId: "MDE2OkNvbnRlbnRSZWZlcmVuY2UxNjA1",
    title: "[A-1234] Error found in core/models.py file",
    body:"You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()"
  }) {
    contentAttachment {
      ... on ContentAttachment {
        id
        title
        body
      }
    }
  }
}

Exemplo de cURL:

curl -X "POST" "https://api.github.com/graphql" \
     -H 'Authorization: Bearer $INSTALLATION_TOKEN' \
     -H 'Accept: application/vnd.github.corsair-preview+json' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "query": "mutation {\\n  createContentAttachment(input:{contentReferenceId: \\"MDE2OkNvbnRlbnRSZWZlcmVuY2UxNjA1\\", title:\\"[A-1234] Error found in core/models.py file\\", body:\\"You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n\self.save()\\"}) {\\n    contentAttachment {\\n      id,\\n      title,\\n      body\\n    }\\n  }\\n}"
}'

Para obter mais informações sobre node_id, consulte "Usando IDs de nós globais".

Exemplo de uso de manifestos do Probot e do aplicativo GitHub

Para configurar rapidamente um aplicativo GitHub que pode usar a API do Anexos do conteúdo, você pode usar o Probot. Consulte "Criando aplicativos GitHub a partir de um manifesto" para saber como o Probot usa manigestos do aplicativo GitHub.

Para criar um aplicativo Probot, siga as etapas a seguir:

1. Gerar um novo aplicativo GitHub.

2. Abra o projeto que você criou e personalize as configurações no arquivo app.yml. Assine o evento content_reference e habilite as permissões de gravação content_reference:

    default_events:
      - content_reference
    # The set of permissions needed by the GitHub App. O formato do objeto usa
    # o nome da permissão para a chave (por exemplo, problemas) e o tipo de acesso para
    # o valor (por exemplo, gravação)
    # Valid values are `read`, `write`, and `none`
    default_permissions:
      content_references: write
   
    content_references:
      - type: domain
        value: errors.ai
      - type: domain
        value: example.org
   

3. Adicione este código ao arquivo index.js para lidar com eventos content_reference e chamar a API REST:

   module.exports = app => {
     // Your code here
     app.log('Yay, the app was loaded!')
      app.on('content_reference.created', async context => {
       console.log('Content reference created!', context.payload)
        // Call the "Create a content reference" REST endpoint
       await context.github.request({
         method: 'POST',
         headers: { accept: 'application/vnd.github.corsair-preview+json' },
         url: `/repos/${context.payload.repository.full_name}/content_references/${context.payload.content_reference.id}/attachments`,
         // Parameters
         title: '[A-1234] Error found in core/models.py file',
         body: 'You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\nself.save()'
       })
     })
   }
   

4. Execute o aplicativo GitHub localmente. Acesse http://localhost:3000 e clique no botão Registrar aplicativo GitHub:

   

5. Instale o aplicativo em um repositório de teste.

6. Crie um problema no seu repositório de teste.

7. Adicione um comentário ao problema aberto que inclui a URL que você configurou no arquivo app.yml.

8. Dê uma olhada no comentário do problema e você verá uma atualização que se parece com isso: