ci: add GitHub Pages deployment workflow and improve documentation#51
ci: add GitHub Pages deployment workflow and improve documentation#51
Conversation
- Add complete GitHub Pages deployment workflow with build and deploy jobs - Enhance check workflow with docs linting validation - Clean up README formatting and improve provider setup documentation - Remove placeholder text from SVG logo
There was a problem hiding this comment.
Pull Request Overview
This PR adds a complete GitHub Pages deployment workflow and improves documentation infrastructure for the project by setting up a Docusaurus-based documentation site with automated deployment.
- Complete GitHub Pages deployment workflow with build and deploy jobs using GitHub Actions
- Docusaurus-based documentation site with proper structure, configuration, and TypeScript support
- Enhanced CI workflow with documentation linting validation
Reviewed Changes
Copilot reviewed 18 out of 22 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/docs.yaml |
New GitHub Actions workflow for building and deploying documentation to GitHub Pages |
.github/workflows/check.yaml |
Enhanced existing CI workflow with documentation linting job |
docs/ directory |
Complete Docusaurus documentation site setup with TypeScript configuration, React components, CSS styling, and markdown content |
README.md |
Minor formatting improvements for OAuth provider setup documentation |
.vscode/settings.json |
VS Code configuration for consistent formatting across file types |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| with: | ||
| path: docs/build | ||
|
|
||
| deploy: |
There was a problem hiding this comment.
The deploy job should only run on push to main branch, not on pull requests. Add a condition 'if: github.event_name == 'push' && github.ref == 'refs/heads/main'' to prevent deployment attempts on PR builds.
| deploy: | |
| deploy: | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Merged the build and deploy jobs into a single job to simplify the workflow and reduce execution time. The Pages environment configuration is now properly set on the single job.
Restore the correct workflow name "Deploy Docs to GitHub Pages" and add necessary permissions for GitHub Pages deployment.
Summary
This PR adds a complete GitHub Pages deployment workflow and improves documentation infrastructure for the project.
Type of Change
Related Issues
Changes Made
The documentation site will be automatically deployed to GitHub Pages when changes are pushed to main branch.