-
-
Notifications
You must be signed in to change notification settings - Fork 15
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
Add TARDIS Bot comments from TARDIS Repo #80
Add TARDIS Bot comments from TARDIS Repo #80
Conversation
Can you describe what you've done to test if this workflow runs correctly? Does it just need to be merged before we can see if it works or are there any other things we could do to test it? |
I will see what I can do to test it. Apologies for not doing that beforehand. |
I'm not quite sure why we need this? Could you add a bit more description? |
I don't have an opinion about whether it's necessary or not. I included it to match the TARDIS workflow. |
.github/workflows/build-docs.yml
Outdated
- name: Post comment (failure) | ||
uses: peter-evans/create-or-update-comment@v1 | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} |
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.
tardis bot token, right?
Is this saved as a secret?
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 line works in other workflows, although I don't know the direct answer to your question off the top of my head.
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.
I think we should use the BOT_TOKEN
here. This also needs to be added in the repo settings.
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.
I think we should use the
BOT_TOKEN
here. This also needs to be added in the repo settings.
Is this what you had in mind?
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.
yes! thank you.
Something very useful that this does is have the tardis bot comment with a URL to the version of the docs on the branch receiving the change |
96bbe27
to
12a3158
Compare
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
12a3158
to
1ae8b3c
Compare
Codecov Report
@@ Coverage Diff @@
## main #80 +/- ##
=======================================
Coverage ? 33.89%
=======================================
Files ? 17
Lines ? 658
Branches ? 0
=======================================
Hits ? 223
Misses ? 435
Partials ? 0 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
* Naively add tardis bot comments to `build-docs.yml` * Change github token to bot token
📝 Description
Type: | 🎢
infrastructure
This includes TARDIS bot actions to leave comments for success or failure of the build-docs workflow.
📌 Resources
Original code
🚦 Testing
How did you test these changes?
☑️ Checklist
build_docs
label