Skip to content

Upgrade documentation workflow#11

Merged
teogor merged 2 commits intomainfrom
docs/improve-deployment-flow
Feb 23, 2024
Merged

Upgrade documentation workflow#11
teogor merged 2 commits intomainfrom
docs/improve-deployment-flow

Conversation

@teogor
Copy link
Copy Markdown
Owner

@teogor teogor commented Feb 23, 2024

Upgrade Documentation Workflow for Drifter Plugin

This pull request introduces several enhancements to the Drifter plugin's documentation workflow, improving efficiency and reliability:

Changes:

  • Streamlined documentation build:
    • Removed unnecessary permissions grant step.
    • Improved dependency installation using pip install --upgrade.
    • Optimized MkDocs build commands.
  • Enhanced API reference relocation:
    • Created a dedicated directory for API references (build/docs/${{ env.REPOSITORY }}/html).
    • Simplified file copying process.
  • Automated pull request creation:
    • Generates a PR title and body with key information.
    • Adds "documentation" label for better organization.
    • Merges the PR automatically (optional, depending on preferences).

Benefits:

  • Faster and more reliable documentation build.
  • Cleaner separation of concerns for MkDocs and API references.
  • Automated PR creation saves time and effort.

@teogor teogor added the @documentation Improvements or additions to documentation label Feb 23, 2024
@teogor teogor self-assigned this Feb 23, 2024
@teogor teogor merged commit 8704787 into main Feb 23, 2024
@zeobot zeobot Bot deleted the docs/improve-deployment-flow branch February 23, 2024 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

@documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

1 participant