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

Better document run_test.r #5479

Merged
merged 8 commits into from
Oct 3, 2024
Merged

Better document run_test.r #5479

merged 8 commits into from
Oct 3, 2024

Conversation

jdblischak
Copy link
Contributor

@jdblischak jdblischak commented Sep 9, 2024

Description

This is a documentation-only PR to better advertise the existence of run_test.r. Most of the documentation only refers to .bat, .sh, and .py, with the occasional reference to .pl. Looking through the entire conda-forge org, I found zero instances of run_test.r; whereas, I found 329 instances of the better documented run_test.py.

I had to do a lot of digging to convince myself that it should work:

At minimum I know run_test.r will work with R recipes, since I just recently added it to r-git2r-feedstock in conda-forge/r-git2r-feedstock@f9d4ff1

Checklist - did you ...

  • Add a file to the news directory (using the template) for the next release's release notes?
  • Add / update necessary tests?
  • Add / update outdated documentation?

@jdblischak jdblischak requested a review from a team as a code owner September 9, 2024 16:09
@conda-bot conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Sep 9, 2024
Copy link

codspeed-hq bot commented Sep 9, 2024

CodSpeed Performance Report

Merging #5479 will not alter performance

Comparing jdblischak:run_test.r (e7277e1) with main (0ef3749)

Summary

✅ 5 untouched benchmarks

@jdblischak
Copy link
Contributor Author

@beeankha is there any interest in reviewing this documentation-only PR? I see that you keep merging in main, but this PR doesn't touch the code, so it's not going to make a difference in the CI checks.

@beeankha
Copy link
Member

Hi @jdblischak thank you for your patience! I'm actively getting some opinions on this addition to see if it's OK to merge; aiming to get it approved and merged before the end of this week, pending CI tests passing (not sure yet what the test failures are indicating, but I will be looking into those in the next few days as well).

@kathatherine
Copy link
Contributor

Thanks so much for helping to improve our documentation! I'll approve once the tests run green.

@beeankha beeankha enabled auto-merge (squash) October 3, 2024 04:00
@beeankha beeankha disabled auto-merge October 3, 2024 04:00
@kathatherine
Copy link
Contributor

@beeankha I know this is just a doc update and it shouldn't affect the CI tests (and also you approved it). Is that failing test a known issue?

@beeankha
Copy link
Member

beeankha commented Oct 3, 2024

@beeankha I know this is just a doc update and it shouldn't affect the CI tests (and also you approved it). Is that failing test a known issue?

The previously-failing tests were a known issue that have been resolved, and now we're just dealing with some CI infrastructure hiccups (i.e. network errors vs test failures). The latest re-run should hopefully come back all green.

Copy link
Contributor

@kathatherine kathatherine left a comment

Choose a reason for hiding this comment

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

ty!

@beeankha beeankha merged commit f76aa2d into conda:main Oct 3, 2024
29 checks passed
@jdblischak jdblischak deleted the run_test.r branch October 3, 2024 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed [bot] added once the contributor has signed the CLA
Projects
Status: 🏁 Done
Development

Successfully merging this pull request may close these issues.

4 participants