-
Notifications
You must be signed in to change notification settings - Fork 441
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
Allow building full docs in PR, opt-in #3800
Conversation
As of now, this PR will only work if the label pre-exists when a commit is pushed. I will push a dummy commit to test. To finish this, we should also run the doc build |
Codecov Report
@@ Coverage Diff @@
## main #3800 +/- ##
=======================================
Coverage 94.15% 94.15%
=======================================
Files 86 86
Lines 18891 18891
=======================================
Hits 17787 17787
Misses 1104 1104 |
.github/workflows/docs.yml
Outdated
@@ -25,6 +26,8 @@ env: | |||
|
|||
jobs: | |||
doc: | |||
# Don't run if we labeled with a label other than `full-doc` | |||
if: ${{ !(github.event.action == 'labeled' && github.event.label.name != 'full-doc') }} |
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.
This doesn't work if any other labeled is added. It will still start the action but not run doc
. This leads to the check not showing up in the PR. Unless we want to run this action everytime a label is added (I wouldn't recommend as we could be adding labels right before merging), I think we will have to push commits to get this label to work. It isn't a big hurdle IMO.
This reverts commit 55c4a29.
Doc build fails as expected here, as I labeled it before pushing the last commit. |
Overview
Allow adding a label to build full docs.
Details
This is opt-in from the perspective of the labelling. PR authors without label write permissions do not have the optionality.