ci: auto-deploy docs to GitHub Pages on push#188
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR changes the existing “API Doc Generation” GitHub Actions workflow from a manual-only run to an automatic run on pushes to the master branch (with path filters), enabling continuous GitHub Pages documentation deployment.
Changes:
- Add
pushtrigger formasterwith path filters foraisdb/**,docs/**, and the workflow file itself. - Keep
workflow_dispatchto allow manual runs alongside the new automatic behavior.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| on: workflow_dispatch | ||
| on: | ||
| push: | ||
| branches: [master] |
Comment on lines
+6
to
+9
| paths: | ||
| - 'aisdb/**' | ||
| - 'docs/**' | ||
| - '.github/workflows/API_doc_manual.yml' |
Comment on lines
+3
to
+4
| on: | ||
| push: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
Summary
Describe what this pull request does and why it is needed.
Changes
Testing
Describe how the changes were tested (unit tests, integration tests, manual verification).
Checklist
cargo fmt --check,cargo clippy, andcargo testin the affected crates.pytest ./aisdb/tests/.