Pular para conteúdo

Alteração dados do Guia de Transparência⚓︎

1- Clonar repositório⚓︎

  • Clonar repositório localmente através do comando:
git clone https://github.com/transparencia-mg/guia-transparencia-ativa.git

2 - Instalação e configuração⚓︎

Ambiente virtual venv⚓︎

  • Se as dependências python não estiverem instaladas em um ambiente virtual venv, siga os passos:
    Nota: Para identificar se as dependências estão instaladas deve existir uma pasta chama venv junto as demais pastas do repositório.
 python -m venv venv
  • Caso as dependências python estejam instaladas, lembre-se de ativar:
. venv/Scripts/activate # windows
. venv/bin/activate # linux

Biblioteca do projeto⚓︎

Verificar se a biblioteca que consta requirements.txt está instalada no ambiente:

pip list # verifica quais bibliotecas estão instaladas

pip install -r requirements.txt  # instala a biblioteca necessária
Observação:
- Após instalação verificar se todas as bibliotecas foram instaladas

2 - Criar nova branch⚓︎

  • Criar uma branch para fazer as alterações necessárias. A nova branch deve ser criada a partir da branch Review.

  • Criar branch a partir da linha de comando:

Acessar a branch Review : 

git checkout review
image

Em seguida crie a nova branch:

git checkout - b <nome da branch>

image

  • Criar branch a partir da web no github:

Entre na branch Review e em seguida digite o nome da nova branch na caixa de pesquisa.

branch

Verificar documento - MKdocs⚓︎

Para verificar qual a situação do documento é necessário usar o comando: 

mkdocs serve
Observação:
Caso o comando retorne erro referente a biblioteca 'babel' ver #66

Copie e cole no navegador a url apresentada:

image

Para retornar o uso da linha de comando digite: ctrl +c

Alterações⚓︎

  • Todas as alterações devem ser realizadas na pasta docs.
  • Antes de realizar o commit é importante verificar se todas as alterações estão conforme o desejado, isso evita um retrabalho desnecessário caso tenha esquecido de algo. Utilize o comando:
mkdocs serve
  • Após todas as alterações e commits serem realizados será necessário a abertura do Pull request.

Importante:
O Pull request deve fazer referência a branch Review e não a branch main

image

  • O responsável pela revisão irá realizar o merge do pull request. Após o merge todas as alterações propostas serão migradas para a branch Review.

Publicar nova versão do Guia de Transparência⚓︎

1- Para fazer a publicação de uma nova versão basta alterar o arquivo Makefile com a versão desejada.

image

2- Outra opção de publicação é rodar o comando mike deploy --push --update-aliases [versão] latest.

Exemplo: Para publicar a versão 'v3' digite: mike deploy --push --update-aliases v3 latest

Atualizar versão já publicada do Guia de Transparência⚓︎

Para atualizar a versão atualmente publicada bastará fazer um push para a branch main.

Nota: Caso ocorra algum erro na atualização utilize o comando: make gh-deploy-mike.

Obs.: Lembrar de ativar ambiente virtual Python com todos os pacotes listados no arquivo requirements.txt instalados antes de rodar make gh-deploy-mike .

Passo a passo⚓︎

O passo a passo de todas as informações acima podem estão disponíveis em:

https://youtu.be/p3IncxI16s0

https://youtu.be/vRK_Pu8Txxc

https://github.com/transparencia-mg/guia-transparencia-ativa/pull/23

https://github.com/transparencia-mg/guia-transparencia-ativa/issues/22

Ultima atualização: August 9, 2023 12:21:39
Criado em: April 19, 2023 16:47:20

Comentários