fix: add requirements.txt and fix pip cache path in autodoc workflow¶
Commit:
c1376db| Autor: CaiooFerreiraa | Data: 2026-03-28 17:53
Visão Geral¶
Este commit adiciona um arquivo requirements.txt e ajusta o caminho do cache do pip no fluxo de trabalho de documentação automática do GitHub Actions. O fluxo é responsável por gerar e implantar a documentação do projeto utilizando MkDocs e a API do OpenAI.
Arquivos Modificados¶
.github/workflows/autodoc.yml¶
Responsabilidade: Gerencia o fluxo de trabalho para geração e implantação automática de documentação.
Exports: Não há exports diretos, mas o arquivo define um fluxo de trabalho do GitHub Actions.
Dependências relevantes:
- actions/checkout@v4: Faz o checkout do repositório.
- actions/setup-python@v5: Configura o ambiente Python.
- cloudflare/wrangler-action@v3: Realiza o deploy para o Cloudflare Pages.
Fluxo:
1. O fluxo é acionado em pushes para a branch main.
2. Faz o checkout do repositório com histórico completo.
3. Configura o Python e instala as dependências listadas em .autodoc/requirements.txt.
4. Gera a documentação utilizando um script Python que chama a API do OpenAI.
5. Constrói o site com MkDocs.
6. Comita os documentos gerados de volta no repositório.
7. Realiza o deploy do site para o Cloudflare Pages.
Atenção: O fluxo depende de variáveis de ambiente para autenticação com a API do OpenAI e o Cloudflare, que devem ser configuradas nos segredos do repositório.
Impacto nas Funcionalidades¶
Com essas alterações, a documentação do projeto será gerada automaticamente sempre que houver um push na branch main, e será implantada no Cloudflare Pages. A adição do requirements.txt facilita a gestão das dependências necessárias para a geração da documentação.