Skip to content

Continuous Integration and Deployment

Documentation Pipeline

Our documentation is automatically built and deployed using GitHub Actions. This ensures that our documentation is always up-to-date and easily accessible.

Pipeline Overview

graph TD
    A[Push to Repository] --> B{Branch?}
    B -->|Main Branch| C[Build Docs]
    B -->|Pull Request| D[Preview Build]
    C --> E[Deploy to GitHub Pages]
    D --> F[Build Status Check]

Features

  1. Automatic Builds
  2. Triggers on every push to main
  3. Triggers on pull requests
  4. Uses caching for faster builds

  5. Supports Mermaid diagrams

  6. Environment Setup

  7. Python 3.11 with pip caching
  8. Node.js 18 for Mermaid support

  9. All dependencies automatically installed

  10. Quality Checks

  11. Documentation builds verified
  12. Preview builds for pull requests

  13. Visual regression testing available

  14. Deployment

  15. Automatic deployment to GitHub Pages
  16. Only deploys from main branch
  17. Force pushes to keep history clean
  18. Uses GitHub's built-in hosting

Configuration

The pipeline is configured in .github/workflows/docs.yml and includes:

name: Deploy Documentation

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v4
      # ... additional steps

Access and Monitoring

  1. Documentation Access
  2. Live site: https://dolpheyn.github.io/antar/
  3. Build status: Check GitHub Actions tab

  4. PR previews: Available in PR comments

  5. Troubleshooting

  6. Check Actions tab for build logs
  7. Verify dependencies in requirements.txt
  8. Test locally using python 00.py docs build

Best Practices

  1. Documentation Updates
  2. Test locally before pushing
  3. Use preview builds in PRs
  4. Keep diagrams up to date

  5. Monitor build status

  6. Maintenance

  7. Regularly update dependencies
  8. Monitor build times
  9. Review and update workflows
  10. Keep documentation fresh

Last Updated: 2024-12-11T15:38:07+08:00