nmfs-fish-tools / ghactions4r

Reusable github actions workflows for R packages
https://nmfs-fish-tools.github.io/ghactions4r/
12 stars 1 forks source link

feat(style-description): use_tidy_description() #67

Closed kellijohnson-NOAA closed 1 year ago

kellijohnson-NOAA commented 1 year ago

Create a workflow for usethis::use_tidy_description().

To do items

Items in this list need to be done before I feel comfortable changing from "draft" to actual PR.

k-doering-NOAA commented 1 year ago

@kellijohnson-NOAA, this looks great! The only thing missing is including the new function use_style_description on the readme. Also, you can remove the .github/workflows/call- file.

I don't think you need to guard against the infinite workflow loop - GitHub will not trigger new workflow runs that were created by previous workflow runs.

what do you think about adding styling the DESCRIPTION file to the doc-and-style-r workflow? I think it does fit will in the scope of this one.

k-doering-NOAA commented 1 year ago

@kellijohnson-NOAA, I'm happy to help wrap this up, if you would like! I can do it myself, or we could work together on it, up to you!

kellijohnson-NOAA commented 1 year ago

@k-doering-NOAA thanks for offering to finish this PR for me. That would be really great if you have time. Sorry that I let it linger for so long.

k-doering-NOAA commented 1 year ago

No worries @kellijohnson-NOAA ! Next time I work on ghactions4r, I'll finish this up :)

k-doering-NOAA commented 1 year ago

@kellijohnson-NOAA I think this is ready to merge - I added usethis::use_tidy_description() to the doc-and-style workflow and tested that it worked.

Do you think you could review, when you have the chance? Not a rush.