-
Notifications
You must be signed in to change notification settings - Fork 24
chore: adjust docs CI triggers #329
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- only build docs for PRs and pushes to main - only deploys docs from main branch
WalkthroughRestricts MkDocs deploy workflow triggers to the main branch for push and pull_request events and retains manual workflow_dispatch. No job or deployment step changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (2)
.github/workflows/mkdocs-deploy.yml (2)
3-8: Avoid wasted CI by canceling superseded runsAdd a concurrency group so newer pushes/PR updates cancel in-flight doc builds.
name: MkDocs Deploy on: push: branches: [main] pull_request: branches: [main] workflow_dispatch: +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true
10-12: Skip builds for draft PRs (run when marked ready)Prevents building docs for drafts; it will build automatically on ready_for_review.
jobs: build-docs: + if: github.event_name != 'pull_request' || github.event.pull_request.draft == false uses: cpp-linter/.github/.github/workflows/mkdocs.yml@main
Uh oh!
There was an error while loading. Please reload this page.
Note
This is really just designed to stop building docs on every push to every branch.
Summary by CodeRabbit