Skip to content
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

Conversation

smokestacklightnin
Copy link
Contributor

@smokestacklightnin smokestacklightnin commented Jul 4, 2023

📝 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?

  • Not sure how to test this on my own branch

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

@jvshields
Copy link
Contributor

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?

@smokestacklightnin
Copy link
Contributor Author

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.

@wkerzendorf
Copy link
Member

I'm not quite sure why we need this? Could you add a bit more description?

@smokestacklightnin
Copy link
Contributor Author

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.

- name: Post comment (failure)
uses: peter-evans/create-or-update-comment@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
Copy link
Member

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?

Copy link
Contributor Author

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.

Copy link
Member

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.

Copy link
Contributor Author

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes! thank you.

@smokestacklightnin
Copy link
Contributor Author

I'm not quite sure why we need this? Could you add a bit more description?

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

@smokestacklightnin smokestacklightnin force-pushed the cd/build-docs-tardis-bot-comments branch from 96bbe27 to 12a3158 Compare July 13, 2023 06:04
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@smokestacklightnin smokestacklightnin force-pushed the cd/build-docs-tardis-bot-comments branch from 12a3158 to 1ae8b3c Compare July 13, 2023 06:05
jvshields
jvshields previously approved these changes Jul 13, 2023
@codecov
Copy link

codecov bot commented Aug 10, 2023

Codecov Report

❗ No coverage uploaded for pull request base (main@887d562). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head a31f414 differs from pull request most recent head 2933599. Consider uploading reports for the commit 2933599 to get more accurate results

@@           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

@atharva-2001 atharva-2001 merged commit f37ba35 into tardis-sn:main Aug 14, 2023
6 checks passed
smokestacklightnin added a commit to smokestacklightnin/stardis that referenced this pull request Sep 20, 2023
* Naively add tardis bot comments to `build-docs.yml`

* Change github token to bot token
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants