GitHub

ACTIVEVersão 1.0.0GitHub

Crie issues e reaja a eventos de repositórios do GitHub.

Ver como JSON

Pré-requisitos

• uma conta no GitHub com acesso ao repositório;
• permissão no iBPMS para criar ou selecionar conexões;
• um Personal Access Token com escopo `repo`.

github.json

{
  "schemaVersion": 1,
  "key": "github",
  "name": "GitHub",
  "description": "Crie issues e reaja a eventos de repositórios do GitHub.",
  "category": "developer",
  "vendor": "GitHub",
  "version": "1.0.0",
  "status": "ACTIVE",
  "credentials": [
    {
      "type": "BEARER_TOKEN",
      "secretLabel": "Personal Access Token",
      "secretPlaceholder": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "helpText": "Gere um token em Settings → Developer settings → Personal access tokens, com escopo repo.",
      "helpUrl": "https://github.com/settings/tokens"
    }
  ],
  "actions": [
    {
      "key": "issue.create",
      "name": "Criar issue",
      "description": "Abre uma issue num repositório, com título e corpo vindos do processo.",
      "inputs": [
        {
          "key": "owner",
          "label": "Dono (organização ou usuário)",
          "type": "TEXT",
          "required": true,
          "description": "Ex.: minha-org"
        },
        {
          "key": "repo",
          "label": "Repositório",
          "type": "TEXT",
          "required": true,
          "description": "Ex.: meu-repo"
        },
        {
          "key": "title",
          "label": "Título",
          "type": "TEXT",
          "required": true,
          "description": "Aceita expressões, ex.: Falha em {{ process.protocol }}"
        },
        {
          "key": "body",
          "label": "Descrição",
          "type": "TEXT",
          "required": false
        }
      ],
      "outputs": [
        {
          "key": "number",
          "label": "Number",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "url",
          "label": "Url",
          "type": "OUTPUT",
          "required": false
        }
      ]
    }
  ],
  "triggers": [
    {
      "key": "issue.opened",
      "name": "Issue criada",
      "description": "Dispara quando uma issue é aberta no repositório.",
      "mode": "PUSH",
      "exclusiveByConnection": false,
      "inputs": [
        {
          "key": "owner",
          "label": "Dono (organização ou usuário)",
          "type": "TEXT",
          "required": true,
          "description": "Ex.: minha-org"
        },
        {
          "key": "repo",
          "label": "Repositório",
          "type": "TEXT",
          "required": true,
          "description": "Ex.: meu-repo"
        }
      ],
      "events": [
        {
          "type": "GENERIC"
        }
      ]
    }
  ]
}

Gerando o token

1. No GitHub, vá em Settings → Developer settings → Personal access tokens.
2. Gere um token com escopo `repo`.
3. Copie o token e cole no campo de credencial do iBPMS.

Proteja a credencial

Guarde o segredo apenas no campo de credencial do iBPMS. Não o coloque em regras, Markdown, capturas de tela ou logs.

Credenciais

Credencial

Personal Access Token

BEARER_TOKEN

Gere um token em Settings → Developer settings → Personal access tokens, com escopo repo.

Campo	Formato esperado
Personal Access Token	ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Abrir guia do provedor

Ações disponíveis

Ação

Criar issue

issue.create

Abre uma issue num repositório, com título e corpo vindos do processo.

Entradas

Campo	Tipo	Obrigatório	Descrição
ownerDono (organização ou usuário)	TEXT	Sim	Ex.: minha-org
repoRepositório	TEXT	Sim	Ex.: meu-repo
titleTítulo	TEXT	Sim	Aceita expressões, ex.: Falha em {{ process.protocol }}
bodyDescrição	TEXT	Não	—

Saídas

Campo	Tipo	Obrigatório	Descrição
numberNumber	OUTPUT	Não	—
urlUrl	OUTPUT	Não	—

Chamada

{
  "connection": "github-producao",
  "operation": "issue.create",
  "inputs": {
    "owner": "{{ context.owner }}",
    "repo": "{{ context.repo }}",
    "title": "{{ context.title }}",
    "body": "{{ context.body }}"
  }
}

Resposta

{
  "number": "…",
  "url": "…"
}

Triggers disponíveis

Trigger

Issue criada

PUSH

Dispara quando uma issue é aberta no repositório.

Configuração

Campo	Tipo	Obrigatório	Descrição
ownerDono (organização ou usuário)	TEXT	Sim	Ex.: minha-org
repoRepositório	TEXT	Sim	Ex.: meu-repo

Eventos normalizados

• GENERIC

Evento recebido

{
  "event": "GENERIC",
  "data": {
    "owner": "{{ context.owner }}",
    "repo": "{{ context.repo }}"
  }
}

Limitações

• o token herda as permissões da conta que o gerou;
• o trigger de issue depende de um webhook configurado no repositório;
• os limites de rate da API do GitHub continuam se aplicando.

Erros comuns

Sintoma	Possível causa	Correção
404 no repositório	Token sem escopo `repo` ou sem acesso	Regenere o token com o escopo correto.
Issue não criada	Repositório arquivado ou somente leitura	Confirme que o repositório aceita novas issues.
Eventos não chegam	Webhook ausente no repositório	Cadastre a URL de callback nas configurações de webhooks.

Veja também

• Todos os conectores
• Integrações
• Solução de problemas