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

Show badge link for add in README.md when test finished. #608

Closed
jhk0530 opened this issue May 13, 2024 · 2 comments
Closed

Show badge link for add in README.md when test finished. #608

jhk0530 opened this issue May 13, 2024 · 2 comments

Comments

@jhk0530
Copy link

jhk0530 commented May 13, 2024

Hi, nice work for this rhub package.

Since I'm not familiar with github action, I really and really appreciate for this easy-to-use R CMD CHECK functions.

Here is just small suggestion.

I really like message : Check started.... See for live output !

and I think it's good to add another message,

You can add badge in your readme.md like this

r-hub
which is from one of my R package that used "rhub" !!

and this badge link can be

![r-hub](https://github.com/<ACCOUNT>/<REPOSITORY>/actions/workflows/rhub.yaml/badge.svg)

I believe rhub has already information about account and repository.

I'm not sure how can I contribute with code here, So just mention this small idea only.

Thanks again !!

@gaborcsardi
Copy link
Collaborator

Hmmm, the thing is, usually these badges show the current state of the repo. On the other hand, since the R-hub workflow typically triggered manually, so typically such a badge would not show the current status.

Of course you run the R-hub workflow for every commit, if you like. Or, you can create a badge, even if it does not always show the status of the latest commit. But I am not entirely sure if we need to encourage this in the rhub package.

@jhk0530
Copy link
Author

jhk0530 commented May 14, 2024

As you said, the R-hub workflow is triggered manually using the rhub_check() function, so I didn't realize that badges don't guarantee the latest commit status.

I agree with you that we don't need that functionality in the R-hub package.

Thanks

@jhk0530 jhk0530 closed this as completed May 14, 2024
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

No branches or pull requests

2 participants