Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 22, 2025

This PR implements automatic documentation generation and deployment using GitHub Actions and MkDocs, addressing the requirement to "modificar los workflows para que se genere la documentacion" (modify workflows to generate documentation).

Changes Made

Added .github/workflows/docs.yml that automatically:

  • Builds MkDocs documentation on every push to main and pull requests
  • Deploys the generated documentation to GitHub Pages when changes are pushed to main
  • Uses the existing mkdocs.yml configuration and documentation in /docs/index.md

Workflow Features

  • Automated Deployment: Documentation is automatically deployed to https://rafnixg.github.io/bcv-api/ on main branch pushes
  • PR Validation: Documentation builds are tested on pull requests to catch issues early
  • Modern Actions: Uses latest GitHub Actions versions for security and reliability:
    • actions/checkout@v4
    • actions/setup-python@v5
    • actions/configure-pages@v5
    • actions/upload-pages-artifact@v4
    • actions/deploy-pages@v4
  • Efficient Builds: Installs only required MkDocs dependencies for faster execution
  • Proper Permissions: Configured with minimal required permissions for GitHub Pages deployment
  • Concurrency Control: Prevents conflicting deployments while allowing production deploys to complete

Technical Details

The workflow consists of two jobs:

  1. Build: Sets up Python 3.10, installs MkDocs with Material theme, and builds the documentation
  2. Deploy: Uploads the built site to GitHub Pages (only on main branch)

The implementation leverages the existing MkDocs setup already present in the repository, requiring no changes to documentation content or configuration files.

Testing

  • ✅ Local MkDocs build verified successful
  • ✅ Generated site structure validated
  • ✅ YAML syntax confirmed valid
  • ✅ Complete workflow simulation tested

Once merged, documentation will be automatically available at https://rafnixg.github.io/bcv-api/ and will update automatically with future changes.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits August 22, 2025 18:02
Co-authored-by: rafnixg <10915285+rafnixg@users.noreply.github.com>
Co-authored-by: rafnixg <10915285+rafnixg@users.noreply.github.com>
Copilot AI changed the title [WIP] Modificar los workflows para que se genere la documentacion. Add GitHub Actions workflow for automatic documentation generation and deployment Aug 22, 2025
Copilot AI requested a review from rafnixg August 22, 2025 18:06
@rafnixg rafnixg marked this pull request as ready for review August 22, 2025 23:17
@rafnixg rafnixg merged commit 31b4b4e into main Aug 22, 2025
3 checks passed
@rafnixg rafnixg deleted the copilot/fix-fbbeca82-0c5f-44b6-ab09-b51c1aa8b9ec branch August 23, 2025 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants