Como integrar GitActions com a Plataforma Digibee

⭐️ O principal benefício para as empresas é a capacidade da plataforma Digibee de se integrar perfeitamente aos seus processos de CI/CD. Isto aborda uma preocupação comum entre empresas com processos robustos de governança e gestão de mudanças.

Este artigo mostra como habilitar a Plataforma Digibee para que se integre aos processos de gestão de mudanças das empresas. Neste artigo, o exemplo de ferramentas utilizadas são Github e GitActions, mas lembre-se que este conteúdo é um exemplo e pode ser ajustado às suas necessidades e integrado com outras ferramentas semelhantes.

Photo by Praveen Thirumurugan on Unsplash

Sumário

Introdução
Repositório
Criar repositório github
Configurar credenciais GitActions
Permissões GitActions
Configurar workflow no projeto
Commit & testes
Utilização pelo desenvolvedor

Introdução

Este guia passo a passo mostrará como configurar um workflow usando GitActions para realizar o commit automático do flowspec do pipeline, aprovar o merge request e implantar o pipeline.

Pre requisitos:

• Conhecimento básico de git
• Conhecimento básico em processos de gestão de mudanças
• Conta Github
• Git cli https://git-scm.com/ instalado
• Github cli https://github.com/cli/cli#installation instalado
• Github autenticado: https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git#github-cli
• Usuário e senha configurados

git config user.email youremail@mail.com
git config user.name "Your name"

• Opcional: VSCode instalado, bem como o Github Actions Plugin, ou Github Dev. Essas ferramentas irão ajudá-lo a customizar o workflow YAML.
• Token Digibeectl, passphrase e key. Se você não souber como obter estas informações. Veja este artigo do Artur Scheiner ou consulte digibee docs

Criar repositório github

Vá para github.com/new e crie um novo repositório para sincronizar com seu pipeline.

Configurar Credenciais GitActions

Vá para as configurações do seu projeto e crie as seguintes credenciais.

• KEY: é a credencial gerada automaticamente no processo de geração do token digibeectl.
• PASS: é a senha que você usou para gerar o token digibeectl.
• TOKEN: é o conteúdo do arquivo de token digibeectl.
• ⚠️ Important: o conteúdo do token deve ser escapado. Adicione \ antes de{ }e "

Exemplo de token digitibeectl

GitActions — variables and secrets

GitActions permissions

Certifique-se de que o workflow tenha acesso read/write no repositório.

Para fazer isso, vá em “Settings > Actions > General” e selecione Read and write permissions.

GitActions permissions to read and write

Configurar workflow no projeto

Fique a vontade para escolher como seguir os próximos passos utilizando linha de comando, VS Code ou outras ferramentas de sua preferência.

• Clone o repositório e crie um novo branch

git clone <https://github.com/....../.......git>
cd {{your-repository}}
git checkout -b features/pipeline-workflow

• Criar pasta: .github/workflow

mkdir .github
cd .github
mkdir workflows

• Crie os arquivos abaixo seguindo os exemplos fornecidos.

./metadata.json
./.github/workflows/commit-flow-spec.yml
./.github/workflows/deploy-pipeline.yml

• metadata.json

{
  "pipelineName": "your-pipeline-name",
  "majorVersion": "1"
}

• commit-flowspec.yml
• deploy-pipeline.yml

Por favor, copie os exemplos mais recentes do meu GitHub.

https://github.com/vchrist1/digibee-pe-hello-world-pipeline/blob/main/.github/workflows/commit-flowspec.yml
https://github.com/vchrist1/digibee-pe-hello-world-pipeline/blob/main/.github/workflows/deploy-pipeline.yml

Commit & teste

Agora você está pronto para testar o workflow.
Realize o commit no branch features/pipeline-workflow.

# verifique se você está no branch esperado, estamos usando outro branch para testar ambos os fluxos.
git branch 
git add .
# verifica os arquivos a serem commitados
git status
# Changes to be committed:
#  (use "git restore --staged <file>..." to unstage)
#  new file:   .github/workflows/commit-flowspec.yml
#  new file:   .github/workflows/deploy-pipeline.yml
#  new file:   metadata.json
git commit -m "teste workflow"
git push

Vá para a página do Github e clique em GitActions. Verifique os workflows GitActions executaram sem erros.

Vamos testar as próximas Actions que irão implantar o pipeline. Para fazer isso, crie um pull request para o branch main e realize o merge.

Pull request

Review, approve and merge

Pipeline deployed by GitActions using digibeectl

Utilização pelo desenvolvedor

Para iniciar o processo de commit automático do flowspec, você pode simplesmente criar um novo commit. Não há necessidade de fazer alterações nos arquivos do projeto.

git checkout main
git pull 
git checkout -b features/example-new-branch
git commit -m  "testando fluxo" --allow-empty
git push

Será feito automaticamente o commit das alterações do pipeline usando o digibeectl por meio do GitActions, e você pode ver essas alterações no arquivo flowspec.json

A próxima etapa é revisar as alterações e promover a branch para a sua branch main, e então acontecerá o deploy do pipeline.