Projeto final: construa o bot de releases
Transforme pull requests mesclados num número de versão, notas de release, issues fechadas e agradecimentos aos contribuidores - o bot que o Dungeon Dash roda a cada release.
- Classificar pull requests mesclados a partir dos títulos no formato de conventional commits
- Gerar notas de release em Markdown, agrupadas, com links e autores
- Combinar versionamento, notas, issues fechadas e agradecimentos aos contribuidores numa única release
Você percorreu um longo caminho: do seu primeiro pull request a revisar os dos outros, montar a CI e blindar os workflows do projeto. Os outros mantenedores têm um último pedido: automatizar as releases. Escrever notas de release à mão leva uma tarde, e sempre alguém esquece de agradecer a um contribuidor.
O bot lê a tag da última release e os pull requests mesclados desde então (como a API os devolve - mesclados com squash, então cada título é um conventional commit) e produz:
1v1.5.0
2
3## v1.5.0
4
5### Features
6- boss battles (#128) @mira
7- **audio:** victory music (#134) @ana
8
9### Fixes
10- **physics:** stop wall clipping after a dash (#131) @kai
11- faster dungeon generation (#137) @mira
12
13### Other changes
14- explain the controls (#133) @sam-sprites
15- bump pillow to 10.3.0 (#136) @dependabot[bot]
16
17Closes: #42, #43, #30, #57, #61
18New contributors: @ana, @kaiO plano
Tudo aqui é uma peça que você já construiu:
- Classificar cada título de PR (aula de conventional commits): tipo, escopo opcional,
!ou uma notaBREAKING CHANGE:no corpo. - Versionar a partir da mudança mais significativa (aula de semver).
- Notas: agrupar as entradas sob títulos, com o número do PR e o autor (aula de Markdown).
- Issues fechadas a partir das palavras-chave de fechamento nos corpos dos PRs (aula de issues).
- Contribuidores: agradecer a todos e dar boas-vindas a quem chega pela primeira vez - pessoas que não estão na lista de contribuidores anteriores.
Construa nessa ordem nos três exercícios: classificar e versionar, depois as notas, depois a release inteira.
1import re
2
3TITLE = re.compile(r"(?P<type>\w+)(?:\((?P<scope>[\w-]+)\))?(?P<bang>!)?: (?P<subject>.+)")
4for title in ["feat(audio): victory music", "fix!: drop the old save format", "Update README"]:
5 match = TITLE.match(title)
6 print(match.groupdict() if match else f"not conventional: {title}"){'type': 'feat', 'scope': 'audio', 'bang': None, 'subject': 'victory music'}
{'type': 'fix', 'scope': None, 'bang': '!', 'subject': 'drop the old save format'}
not conventional: Update READMEGrupos nomeados ((?P<type>...)) deixam a análise legível, e os títulos que não seguem a convenção caem em “Other changes” em vez de quebrar o bot - repositórios reais sempre têm alguns.
Rodando no GitHub
Quando o script funcionar, um workflow o roda na hora da release: um mantenedor clica em Run workflow, o bot calcula a versão e as notas, e o gh release create as publica. Repare nas permissões e nas versões fixadas da aula de segurança:
1name: Release
2on:
3 workflow_dispatch:
4
5permissions:
6 contents: write # to create the tag and release
7 pull-requests: read
8
9jobs:
10 release:
11 runs-on: ubuntu-latest
12 environment: release # requires a maintainer's approval
13 steps:
14 - uses: actions/checkout@v4
15 with:
16 fetch-depth: 0 # full history, so the last tag is available
17 - name: Collect merged pull requests
18 env:
19 GH_TOKEN: ${{ github.token }}
20 run: |
21 last_tag=$(git describe --tags --abbrev=0)
22 echo "$last_tag" > input.txt
23 gh pr list --state merged --search "merged:>$(git log -1 --format=%cI "$last_tag")" \
24 --json number,title,author,body --jq '.[] | {number, title, author: .author.login, body}' -c >> input.txt
25 - name: Build the release
26 run: python scripts/release_bot.py < input.txt > release.md
27 - name: Publish
28 env:
29 GH_TOKEN: ${{ github.token }}
30 run: gh release create "$(head -n 1 release.md)" --notes-file <(tail -n +3 release.md)Para onde ir agora
- Contribua de verdade: encontre um projeto que você usa, leia o CONTRIBUTING.md dele e escolha uma good first issue.
- Automatize os seus próprios repositórios: acrescente CI, Dependabot e um workflow de release a um projeto seu.
- Aprofunde-se: workflows reutilizáveis e composite actions, GitHub Apps, Codespaces para ambientes de desenvolvimento na nuvem e o GitHub Copilot.
- Ferramentas de release: o release-please e o semantic-release fazem o que o seu bot faz, para muitos ecossistemas.
Principais conclusões
Títulos de PR convencionais tornam versões e notas de release calculáveis.
Agrupe as notas por tipo, crie links para os PRs e dê crédito aos autores - e trate os títulos que não seguem as regras.
As palavras-chave de fechamento e as listas de contribuidores vêm direto dos PRs mesclados.
Rode a automação de releases num workflow com permissões de menor privilégio e uma etapa de aprovação.
Quiz da aula
6 perguntas · aprovação com 5 acertos · até 50 XP
Ao passar, você conclui a aula e mantém sua sequência. As perguntas erradas voltarão em sessões de revisão.
Pratique: automatize tarefas do GitHub com Python
O trabalho real no GitHub envolve muita automação pequena: conferir CODEOWNERS, expandir matrizes de build, atualizar versões, ler a API. Escreva esses utilitários em Python e execute-os com entradas de exemplo, localmente no navegador e sem precisar de conta no GitHub.
Classifique os PRs mesclados
A primeira linha de entrada é a tag da última release; cada linha seguinte é um PR mesclado em JSON, com number, title, author e body. Para cada PR, imprima #128 feature: boss battles (tipos: breaking para um ! ou um BREAKING CHANGE: no corpo, feature para feat, fix para fix e perf, e other nos demais casos; títulos não convencionais são other com o título inteiro). Depois imprima next: v1.5.0, ou next: none quando não houver nada para lançar.
- Release de primavera
- Release grande
- Nada para lançar
O Python é executado em um ambiente isolado no navegador, com limite de 60 segundos. O runtime é carregado pelo CDN do Pyodide; seu código permanece neste navegador.
Escreva as notas de release
Usando a mesma entrada, imprima notas de release em Markdown: ## v1.5.0 e depois - cada uma precedida de uma linha em branco - as seções ### ⚠️ Breaking changes, ### Features, ### Fixes e ### Other changes, nessa ordem, pulando as vazias. Cada entrada é - subject (#N) @author, com **scope:** antes do assunto quando houver escopo. Se não houver nada para lançar, imprima No release needed. no lugar.
- Release de primavera
- Release grande
- Nada para lançar
O Python é executado em um ambiente isolado no navegador, com limite de 60 segundos. O runtime é carregado pelo CDN do Pyodide; seu código permanece neste navegador.
Publique a release inteira
Junte tudo. A entrada é a mesma, mais uma linha final known: mira sam-sprites ... listando todo mundo que já contribuiu antes. Imprima:
- a versão numa linha própria, depois uma linha em branco e depois as notas de release (como no exercício anterior);
- uma linha em branco e depois
Closes: #42, #43- cada issue fechada por uma palavra-chave de fechamento no corpo de um PR (palavra-chave antes de cada referência), em ordem, sem duplicatas - ouCloses: none; New contributors: @ana, @kai- autores que não estão na lista de conhecidos, em ordem, ignorando bots (nomes terminados em[bot]) - ouNew contributors: none.
Se não houver nada para lançar, imprima só No release needed.
- Release de primavera
- Release grande
- Nada para lançar
O Python é executado em um ambiente isolado no navegador, com limite de 60 segundos. O runtime é carregado pelo CDN do Pyodide; seu código permanece neste navegador.
Dúvidas sobre esta lição
Travou em algum ponto? Pergunte. Descobriu algo? Compartilhe. Explicar também é uma ótima forma de aprender.
Carregando publicações…