ci: add GitHub Pages deployment and improve docs workflow#50
Closed
ci: add GitHub Pages deployment and improve docs workflow#50
Conversation
- Add docs-check job to check.yaml with working-directory defaults - Create docs.yaml workflow for building and deploying to GitHub Pages - Configure proper permissions and concurrency for Pages deployment
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the CI/CD pipeline by adding GitHub Pages deployment capability and improving the documentation workflow structure. The changes introduce automated documentation deployment from the main branch while maintaining quality checks through improved linting workflows.
- Adds a new GitHub Pages deployment workflow for automatic documentation publishing
- Enhances the existing check workflow with a dedicated docs-check job using cleaner working directory defaults
- Implements proper permissions and concurrency controls for Pages deployment
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.github/workflows/docs.yaml |
New workflow for building and deploying Docusaurus documentation to GitHub Pages |
.github/workflows/check.yaml |
Added docs-check job with working directory defaults for documentation linting |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Co-authored-by: Copilot <[email protected]>
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.
Summary
This PR adds GitHub Pages deployment workflow and improves the documentation CI workflow:
check.yamlto useworking-directorydefaults instead of manualcdcommands for cleaner workflowdocs.yamlworkflow that builds Docusaurus documentation and deploys to GitHub PagesType of Change
Related Issues