Skip to content

Como utilizar a ferramenta de criação de issues

Isabel Elise edited this page Jul 1, 2022 · 8 revisions

Objetivo

O objetivo dessa ferramenta é automatizar a criação de issues que possuem um template padrão. Atualmente, as issues que se encaixam nesse contexto são as issues de solicitação de coleta e as issues de teste de generalização. Tendo isso em mente, esse tutorial irá apresentar como utilizar o gerador de issues nesses dois contextos.

Requisitos

Inicialmente, é necessário que você crie uma token para acesso ao GitHub. Os passos para criação da token são:

  1. Settings;
  2. Developer settings;
  3. Personal access tokens; e
  4. Generate new token;

Obs.: É importante que você dê a token acesso a escrita!

Após a criação da token, vamos de fato utilizar a ferramenta de criação de issues.

Como acesso essa ferramenta humano?

A ferramenta de geração de issues está rodando na infra do MPMG. Para acessá-la é necessário que você tenha:

  1. Login e Senha do DCC;
  2. Login e Senha no MPMG.

Para realizar o acesso você deve fazer um túnel SSH, utilizando o seguinte comando no terminal.

ssh -Y -N -L localhost:8060:localhost:8060 vm_f01

Nesse caso, vm_f01 é o nome dado para a nossa vm no arquivo de configuração SSH. Caso você não tenha esses dados acesse nosso canal de informações no Discord.

Após fazer acesso com seu login e senha, você deve acessar no seu navegador o caminho:

http://localhost:8060/

Após realizar o acesso, essa será a interface que você irá visualizar.

inicial

Explicando os campos

  1. Campo onde você deve entrar com a token criada no Github;
  2. Nome do repositório onde você deseja criar as issues;
  3. Nome do seu usuário no GitHub;
  4. Nome da Tag da issue a ser criada (e.g. Licitação, Despesas, Pagamentos);
  5. Qual o tipo de issue, Solicitação de Coleta? Issue de teste de generalização?;
  6. Carregamento do arquivo com os dados a serem criados.

Arquivo de configuração para criação de issues de solicitação de coleta

Você deve carregar na ferramenta um arquivo ".json" no seguinte padrão:

{"<NOME DO MUNICIPIO>": "<LINK DO PORTAL>", "<NOME DO MUNICIPIO 2>": "<LINK DO PORTAL>"}

Um exemplo preenchido que você pode usar para teste é apresentado a seguir:

{"Sete Lagoas": "https://transparencia.setelagoas.mg.gov.br/transparencia", "Governador Valadares": "link"}

Arquivo de configuração para criação de issues de teste de generalização

["<NOME DO MUNICIPIO>", "<NOME DO MUNICIPIO 2>"]

Um exemplo preenchido que você pode usar para teste é apresentado a seguir:

["Sete Lagoas", "Governador Valadares"]

Criando uma issue de solicitação de coleta

  1. Preencher os campos
  2. Subir o arquivo de confirmação

preenchido

  1. Clicar em Show issues

warning

  1. Após visualizar as issues você confirma que visualizou
  2. Confirma ou não a criação das issues

concorda

  1. Clica na botão criar issues.

Caso tudo tenha dado certo, você receberá uma mensagem falando que as issues foram criadas com sucesso!