CircleCI setup for PR documentation previews #104
Conversation
melissawm
force-pushed
the
circleci-project-setup
branch
from
3f61361 to
ac0949e
Compare
github-actions
bot
added
the
documentation
melissawm
force-pushed
the
circleci-project-setup
branch
from
ac0949e to
47a9cbe
Compare
github-actions
bot
removed
the
documentation
|
OMG so excited for this! Let me know if I can help with anything!! |
melissawm
force-pushed
the
circleci-project-setup
branch
2 times, most recently
from
8cb8f3f to
1247be7
Compare
melissawm
force-pushed
the
circleci-project-setup
branch
from
b11db80 to
226dbf6
Compare
|
Ok! I got the first part - CircleCI is set up and you can get a status update with the link to the artifact!!! 🎉 Please check it out here: melissawm#3 Note that this doesn't work on this PR, as the setup only works if the CircleCI job is already committed to the main branch. I did that to my own fork, so you can navigate to the PR above and click on the Details of the "Check the rendered docs here" check:
This is a proof of concept, and there are no hard feelings if this doesn't get merged in the end 😄 I personally like this, but it needs a little more work because we would need to rewrite/replace the deploy_docs action here. Now that the basic details are set up I don't think it would be too difficult. Last note is that this requires a github token with access to the repo, which I've done on my fork. |
|
Outstanding! I love the small Melissa icon (docs 👸) and the clear instructions on the action to click! |
Why? Is it just to not have to maintain lots of different CI jobs? If so I reckon just leave it, we can cross that bridge later.
Erm I wanna merge the thing! 😂 |
|
Lol that is good with me - yeah I was just thinking we could have shorter CI and less use if resources but we can definitely do that later. Let me remove from draft then 😁 |
| permissions: | ||
| statuses: write | ||
| name: Run CircleCI artifacts redirector | ||
| # if: github.repository == 'napari/docs' |
There was a problem hiding this comment.
Should this line be changed to be un-commented before merging? Based on the line at the top of the file to enable this workflow on a fork comment out:
There was a problem hiding this comment.
Yeah - so if this is commented the action also runs on forks (the case now that I'm running this on my fork). We should probably remove this before merging. If you folks are ready for that (i.e. no other reviews are necessary) I can do that.
There was a problem hiding this comment.
For me, the code seems correct and it works on your fork...
This doesn't directly affect the website or any end users, so I'd be game to merge sooner rather than later and then if need be tweak something? Dunno if that makes sense in the grand scheme of things—will defer to others with more experience, like you and @jni
There was a problem hiding this comment.
Why? By default, a contributor will not have circleCI configured, so the workflow will not be triggered. But could a contributor allow testing without creating PR? I would rather see a limited list of branches.
There was a problem hiding this comment.
Wait, am I missing something?
I understood this action would still run on PRs in this repo, and make a clickable link like the numpy PRs...
See #98 (comment)
The contributor shouldn't need to do anything on their fork I don't think once this is in main anyways.
There was a problem hiding this comment.
Sometimes people work on their Fort until get a satisfying solution to not depend on the test queue of the napari organization.
There was a problem hiding this comment.
Hmm, fair enough. But I think docs contributors may be less savvy and more like end-users, rather than developers, so this PR is a nice quality of life improvement where they can see the rendered docs online.
There was a problem hiding this comment.
It is my understanding this will only run in their forks if they do sign up with CircleCI - otherwise they won't have the appropriate credentials.
There was a problem hiding this comment.
I don't have an opinion here. It's easy enough for a contributor to edit that line... Is this ready other than this discussion?
|
I will merge this as it is to enable it in the repository and observe it in the wild. |
Description
Initial CircleCI set up to allow for PR documentation previews.
Type of change
References
Addresses #98
Final checklist: