Pular para o conteúdo principal

Como Usar o Módulo

Aprenda a seguir como utilizar o módulo CNPJ Alfanumérico:

Confira o vídeo a seguir:

Pré-requisitos

Antes de começar, siga as instruções a seguir para criar e configurar um Personal Access Token (PAT) no GitHub e conectá-lo à StackSpot.

1. Criar um Personal Access Token (PAT) no GitHub

Siga as etapas a seguir:

1. Acesse o GitHub da sua organização;

2. Clique no seu avatar e selecione 'Settings';

3. Agora clique em 'Developer settings';

4. Clique em 'Personal access tokens' e depois em 'Tokens (classic)';

5. Clique no botão 'Generate new token' > 'New token (classic)';

6. Em 'Note', adicione um nome para o token e defina uma data de expiração;

7. Marque os escopos repo e workflow;

8. Clique em 'Generate token'.

O token será exibido apenas uma vez. Copie e guarde em um local seguro; você irá usá-lo na StackSpot.

Informação Adicional

Se sua organização utiliza SSO, clique no botão 'Configure SSO' para autorizar o token.

Confira o vídeo a seguir:

2. Conectar o PAT à StackSpot

1. No Portal da StackSpot, acesse o menu 'Conta';

2. Em 'Meu Perfil', clique no botão 'Conexões Externas';

3. Clique no botão 'Conectar' (ou, se já estiver conectado, clique em 'Desconectar' e depois em 'Conectar');

4. Preencha os campos a seguir:

  • Usuário do GitHub
  • Token Pessoal

5. Clique no botão 'Conectar'.

Confira o vídeo a seguir:

3. Você precisa ter permissão de leitura e escrita nos repositórios do GitHub.

Como usar o módulo CNPJ Alfanumérico do Code Shift

A seguir, confira como usar o módulo CNPJ Alfanumérico. Siga os passos para importar repositórios e executar a análise e correção:

Passo 1. Importar repositórios

Importar um único repositório

1. Acesse o Portal da StackSpot EDP e faça login;

2. Selecione 'Code Shift';

3. Clique no botão 'Importar Repositório';

4. Escolha a opção 'Repositório único';

5. Preencha os campos a seguir:

  • Tags para associar: selecione as tags que representam o repositório;
  • URL do repositório: exemplo https://github.com/seu-org/seu-repo;
  • Branch padrão: exemplo main ou develop;

6. Clique no botão 'Importar'.

Confira o vídeo a seguir:

Importar múltiplos repositórios via CSV

Você pode importar vários repositórios usando um arquivo CSV. Confira a seguir:

1. No Code Shift, clique no botão 'Importar Repositório';

2. Em Selecione como você quer importar seu repositório: selecione a opção 'Arquivo CSV' e clique no botão 'Selecionar um arquivo';

3. Crie um arquivo CSV com as informações dos repositórios;

  • Confira a seguir um modelo de como você deve criar este arquivo;
url,branch
https://github.com/customer-org/demo-cnpj-java,main

4. Selecione as tags para associar: crie tags para agrupar os seus repositórios;

As tags ajudam você a organizar e agrupar os repositórios importados. Por exemplo, se o seu time trabalha com Pix, use tags como time.pix ou pix/team2. Isso facilita a visualização e filtragem nos relatórios. Antes de criar uma nova tag, verifique se já existem tags criadas pela sua Organização. Se não encontrar nenhuma adequada, crie novas tags para agrupar os repositórios conforme a sua necessidade.

5. Clique no botão 'Importar'.

Informação Adicional

Você não precisa primeiro escanear e depois corrigir, como mostrado no exemplo a seguir. Os passos são apenas uma demonstração de como funciona. Você pode escolher apenas escanear, ou apenas corrigir e escanear.

Confira o vídeo a seguir:

Passo 2. Executar o primeiro Scan (Escanear)

1. Na lista de repositórios, clique no botão 'Ver detalhes' no repositório desejado;

2. Na página de relatórios, clique no botão 'Executar';

3. Na primeira execução, conecte-se ao GitHub:

  • Informe seu usuário do GitHub;
  • Cole o token pessoal criado anteriormente;
  • Clique no botão 'Salvar';

4. Selecione o módulo 'CNPJ Alfanumérico';

5. Em 'Modo', escolha a opção 'Escanear';

6. Em 'Lista de sinônimos', adicione ou remova palavras-chave relacionadas ao CNPJ usadas no seu repositório;

Informação Adicional

  • A lista de sinônimos é um campo do próprio módulo. No caso do CNPJ, o módulo já traz uma lista pré-preenchida com termos relacionados, como: CNPJ, digitodocto, documento, numerodocumento, digitodocumento, nrodocto, numerodocto, numdocto, numdocumento, nrodocumento, filialdocto, filialdocumento, CGC.

  • Você pode adicionar ou remover outros termos conforme o contexto do seu projeto. Exemplo: codcliente

  • Essa lista é importante porque define os termos que o módulo vai procurar durante o escaneamento.

7. Em 'Programming languages': selecione All.

8. Clique no botão 'Confirmar' para iniciar a execução.

Confira o vídeo a seguir:

Passo 3. Acompanhar o status e analisar o Relatório

1. Acesse a aba 'Status' para acompanhar o andamento da execução;

2. Após a conclusão da execução, clique no botão 'Report link' para acessar o relatório;

3. Você poderá visualizar os dados a seguir:

  • Arquivos analisados;
  • Número de issues detectadas por arquivo.

4. Para detalhes de cada issue, clique no botão 'Ver informações do arquivo' para ser direcionado à linha correspondente no repositório.

Passo 4. Corrigir as issues encontradas (Escanear e corrigir)

1. No repositório desejado, clique no botão 'Ver detalhes';

2. Clique no botão 'Executar' novamente;

3. Selecione o módulo 'CNPJ Alfanumérico';

4. Em 'Modo', escolha a opção 'Escanear e Corrigir';

5. Informe os seguintes campos:

  • Sinônimos: você pode adicionar mais itens à lista de sinônimos, ou mantê-la como está.
  • Programming Language: adicione 'All' para indicar todas as linguagens. Se preferir, você pode escolher uma linguagem de programação específica.
  • Branch de destino: adicione a branch (exemplo: fix/cnpj);

6. Clique no botão 'Confirmar';

7. A StackSpot AI fará as correções automaticamente. Acompanhe o progresso na aba 'Relatórios > Status';

8. Ao final, um Pull Request será criado com as correções;

9. Revise as mudanças e faça o merge do Pull Request na branch correta.

Dica!

Para mais informações sobre o escaneamento, confira o relatório completo da execução clicando em Report link.

Confira o vídeo a seguir:

Editar um repositório

Siga os passos a seguir para editar as informações de um repositório:

Passo 1. Escolha o repositório que deseja atualizar e clique no botão**'Ver detalhes'**;

Passo 2. Clique no botão 'Configurações';

Passo 3. Clique no botão 'Editar';
Atualize a URL do repositório, a branch padrão ou adicione tags, se necessário;

Passo 4. Clique no botão 'Salvar' para aplicar as alterações.

Confira o vídeo a seguir:

Deletar um repositório

Para deletar um repositório cadastrado, siga os passos a seguir:

Você só pode acessar esta opção se tiver permissão para deletar o repositório.

Passo 1. Escolha o repositório que deseja remover e clique no botão 'Ver detalhes';

Passo 2. Clique no botão 'Configurações';

Passo 3. Clique no botão 'Deletar repositório'.

Cuidado!

Ao deletar um repositório, essa ação não pode ser desfeita.