Entrega contínua de blogs Hugo com GitHub Actions
Aprenda a agilizar o worflow de publicação do seu blog feito com Hugo usando entrega contínua (continuous delivery) com GitHub Actions para atualizar automaticamente a página no GitHub Pages.
O Hugo é hoje um dos melhores e mais populares geradores de sites estáticos. Já o GitHub Pages oferece um excelente serviço para distribuir gratuitamente conteúdos estáticos, o que é perfeito para blogs. Logo, é natural que as duas ferramentas sejam comumente usadas em conjunto.
A partir do momento que o blog estiver todo configurado, com todos os templates customizados da forma como queremos, o dia-a-dia do blog passa a revolver em torno da criação de conteúdo.
Existem várias formas de trabalhar, mas qualquer workflow escolhido terá um mínimo de passos comuns:
- Criar um novo conteúdo (como posts, artigos, imagens, etc)
- Rodar o comando
hugocom alguma parametrização para gerar o conteúdo estático atualizado - Publicar o novo conteúdo estático no repositório
<nomeusuario>.github.io
O restante deste artigo vai tratar de configurar um workflow usando GitHub Actions para automatizar o processo de gerar conteúdo estático e publicá-lo. Ao final, teremos um processo de entrega contínua para nosso blog.
Nosso esquema será esse: Commit na master -> Workflow GitHub Actions -> Blog github.io atualizado
A única ação necessária será um commit no branch master contendo as alterações desejadas. Estou usando este fluxo de trabalho e o considero bem fácil e prático.
O tutorial abaixo assume que você está usando dois repositórios:
- Repositório com o template do Hugo e o conteúdo
- Repositório
<nomeusuario>.github.io
E tudo o que você precisa para implementá-lo é seguir os passos descritos abaixo.
#Configuração do workflow de CI/CD com GitHub Actions
Até uns dias atrás, eu nunca tinha trabalho com as ferramentas de CI/CD do GitHub. Mas o GitHub Actions se mostrou bastante fácil de aprender, especialmente para quem já tem alguma experiência com ferramentas de CI/CD como o Circle CI ou Travis.
O GitHub Actions chama os pipelines de workflows. Para criar um novo workflow, primeiro você deve criar, na raiz do repositório do seu blog (onde fica seu template), a seguinte estrutura de diretórios:
.github/workflows
Dentro você terá de adicionar um arquivo de workflow. Ele pode ter qualquer nome, e deve terminar com a extensão .yml ou .yaml.
Abaixo, podemos ver o workflow que estou usando no meu blog atualmente, já comentado. Você também pode baixar ele aqui.
Sera necessário subsituir algumas variáveis no template, como o <nomeusuario>, o <email-valido>, e o template utilizado.
Além disso, você deve ter notado que em dois momentos precisamos de um token do GitHub, como nesta linha: github_token: ${{ secrets.CD_BLOG_TOKEN }}. É bem fácil gerar e cadastrar este token.
Provavelmente, habitalando somente a opção "public_repo" já deve funcionar, mas não testei esta opção. Se você quiser testar, pode deixar um comentário contando se funcionou.
Feito isso, clique em Generate token e uma tela vai abrir. Salve este token, ele é importante. Agora, precisaremos criar um Secret no nosso repositório.
Navegue para as configurações do seu repositório, e na seção Secrets, cadastre um secret com o nome CD_BLOG_TOKEN, com o token como valor.
Feito isso, basta fazer um commit na master e o workflow será disparado. Você pode acompanhar o resultado em Actions:
Se o processo ocorrer sem problemas, você vai ver todos os jobs com sucesso e o seu blog vai estar atualizado.
#Agendamento de posts
Esta abordagem também permite a publicação automática de posts agendados. A resposta está no começo do workflow. Podemos configurar um agendamento através de uma expressão cron simples, como esta:
Esta expressão descreve a frequência de deploy nos seguintes termos:
┌───────────── minuto (0 - 59) │ ┌───────────── hora (0 - 23) │ │ ┌───────────── dia do mês (1 - 31) │ │ │ ┌───────────── mês (1 - 12 ou JAN-DEZ) │ │ │ │ ┌───────────── dia da semana (0 - 6 ou DOM-SAB) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
Assim, nossa expressão 0 0 5 * * significa que o workflow deve ser disparado todos os dias, de todos os meses, às 5 horas da manhã.
No cabeçalho dos nossos posts, precisamos definir a data de postagem:
Se publicarmos este post com data futura para o branch master, por padrão o Hugo não vai incluí-lo na geração do site. O workflow será executado todos os dias às 5 horas da manhã, até o dia 3 de julho de 2032, a data agendada para esta postagem, e ela será incluída na publicação do site deste dia em diante.
#Trabalhando com branches
Por fim, esta abordagem também nos permite escrever os posts em branches individuais, sem marcar os posts com draft = true. Eu crio branches no formato post/nome-do-branch. Quando está pronto, é só fazer merge para o branch master que o processo vai ser disparado.
E é isso. Espero que essas dicas sejam úteis. E se você usa alguma outra estratégia ou tem alguma dica útil, compartilhe nos comentários.