[MOB-12295] publish docs to netlify #736
Conversation
|
|
Diff Coverage: Not applicable. There was no coverage data reported for the files in this diff. Total Coverage: This PR will not change total coverage. 🛟 Help
This is from Qlty Cloud, the successor to Code Climate Quality. Learn more. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
Sets up automated documentation deployment to Netlify for the React Native SDK project, enabling continuous documentation publishing for both production and preview environments.
- Configures Netlify deployment with caching, security headers, and build settings
- Adds GitHub Actions workflow for automatic documentation deployment on master/main pushes and PRs with "documentation" label
- Updates README to include API documentation link and reorganizes content structure
- Provides comprehensive setup and usage documentation for the deployment process
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| netlify.toml | Netlify configuration with build settings, caching headers, and security policies |
| .github/workflows/deploy-docs.yml | GitHub Actions workflow for automated documentation deployment |
| docs-deployment.md | Complete documentation setup and usage guide for Netlify deployment |
| README.md | Updated with API documentation link and reorganized table of contents |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| # Only run on master/main pushes or PRs with "documentation" label | ||
| if: | | ||
| github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main') || | ||
| github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'documentation') || |
There was a problem hiding this comment.
The workflow condition checks for 'documentation' label but the documentation mentions using 'docs' label. This mismatch will prevent preview deployments from triggering when users follow the documented instructions.
| github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'documentation') || | |
| github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'docs') || |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
Looks like a valid suggestion
| - Updates the main documentation URL | ||
|
|
||
| ### Preview Deployment | ||
| - Triggers on pull requests with the "docs" label |
There was a problem hiding this comment.
Documentation states preview deployments trigger with 'docs' label, but the actual workflow checks for 'documentation' label. This inconsistency will cause confusion and prevent expected functionality.
Copilot uses AI. Check for mistakes.
2 participants
🔹 JIRA Ticket(s) if any
✏️ Description
Publish documentation to netlify