Skip to content

Configurar GitHub Actions para publicar documentação da API no GitHub Pages #54

@Diego-Espindola

Description

@Diego-Espindola

Tarefas:

  • Criar script para exportar o openapi.json a partir do app principal.
  • Configurar workflow no GitHub Actions para:
  • Exportar o schema OpenAPI
  • Gerar docs/index.html usando redoc-cli
  • Publicar automaticamente no GitHub Pages (branch gh-pages)
  • Habilitar GitHub Pages no repositório, apontando para a branch gh-pages.
  • Validar acesso à documentação pública no endereço do repositório.

Critérios de aceitação:

O workflow deve rodar em cada push na branch main.
A documentação deve estar disponível publicamente via GitHub Pages.
O processo deve ser automatizado, sem necessidade de commit manual dos arquivos de documentação.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions