[INFRA] Link to doc builds in CI checks #315
Conversation
|
You'll also need to change your doc build name to be It would be better to enhance the app to add config options for this sort of thing, but JavaScript is not my forte... |
jasmainak
force-pushed
the
add_quick_artifact
branch
from
808e06c
to
e217268
Compare
|
Sounds reasonable to me. |
|
@jasmainak Do you want to add a commit to test it out? |
| @@ -1,6 +1,6 @@ | |||
| version: 2 | |||
| jobs: | |||
| build: | |||
| build_docs: | |||
There was a problem hiding this comment.
BTW I pushed a commit to circleci-artifacts-redirector that made it so that build is okay, too. But build_docs might be a clearer name anyway.
jasmainak
force-pushed
the
add_quick_artifact
branch
from
4cea28c
to
e217268
Compare
jasmainak
force-pushed
the
add_quick_artifact
branch
from
e217268
to
9d34c6a
Compare
|
@effigies I squashed the two commits to force a rebuild. You can check out the quicklink now. |
|
LGTM: |
effigies
changed the title
|
Super cool! I love this. Is there a way to make the fact that the docs have been rendered a little clearer? I’m not sure folks will know to click on the 3rd CI test in a group of 4. Netlify has a bot that comments for you when the link is ready, but if that doesn’t exist maybe we could add a comment in the PR template? Something like “Click on the No worries if this is too hard, it’s a super useful contribution!! |
|
It's possible in principle at the app end. The trade-off is that multiple comments per PR becomes spam-like over time with many commits. To reduce it (change to one comment per PR that gets edited) hurts discoverability/usability probably even worse than a commit status. But in the end the blocker is really just that someone (not me!) needs to volunteer to code the functionality, and make it configurable. It's JavaScript and the GitHub API is actually pretty simple if someone wants to try! |
|
@KirstieJane can you point us to the netlify bot that does that? My first thought was also that the app should comment with every commit but I agree it can produce a bit of spam. Or perhaps it should look at the diff when making the PR and point to the file with the maximum number of lines changed. I think all this is possible with javascript but I didn't want to volunteer with my limited javascript knowledge :) But it sounds like a fun hackathon project. |
|
I am confused, what extra in the last comments you would like on top of that nice ci/circleci: build_docs artifact which is how present in the status for the every build? Edit: I would vote to not add more of bot comments since indeed they would occlude possible discussions. |
|
@jasmainak: here’s a PR with an example of the netlify bot commenting: the-turing-way/the-turing-way#613 @larsoner: I see your point about editing all the time. My experience has been that the edits are quite smooth because I think it keeps appearing at the bottom? I think it’s probably a UI win that I don’t think about it so I can’t answer your question properly! 😂🤣😂 @yarikoptic: I don’t think the link is very discoverable, so my suggestion was to highlight the work that has been implemented. No need to implement anything new. Certainly not your responsibility @larsoner!! I think noting it in the PR template is probably the easiest way to help folks know that the spec is built already 🌸 (Edited to actually include the link 🤦🏼♀️ and clarify that the bot comment keeps changing at the top not the bottom of the PR) |
|
I'm seeing we didn't merge this. Given that this is an improvement as-is, and there's not a lot of motion to try to improve right now, I'm going to merge. I've created an issue (#326) to update the PR template and/or move to a top-commenting + editing bot like netlify. |
This PR introduces a quick link to the specification when a PR is made. To enable this, we would have to install this app: https://github.com/larsoner/circleci-artifacts-redirector. It was developed by @larsoner from the MNE team. If people agree, I think it can really help in reviewing PRs here.