document options to keep the README up-to-date

[maelle]

E.g. link to GitHub Action workflows that knit the README on schedule (as we have in ropensci/software-review) https://github.com/ropensci/software-review/blob/master/.github/workflows/main.yml

[mpadge]

Yeah, great idea. It shall be done. Thank you!

[maelle]

@mpadge friendly reminder

[mpadge]

Oh yeah, thank you!!

[mpadge]

First workflow run ran perfectly: https://github.com/ropensci/allcontributors/actions/runs/11894746363/job/33142671637.
I'll link to file in this repo as an example

[maelle]

another idea that could be mentioned, without CI: if you use usethis' release issue checklist, you can store custom items as an internal function. One item could be "run allcontributors". See https://usethis.r-lib.org/reference/use_release_issue.html#customization

[mpadge]

That's cool, but it doesn't really explain how it actually works. I guess that both

1. The unexported function would have to be defined in this package? And but then
2. The namespace of this package would have to be loaded for that function to work at all?

It's then not clear to me how that's actually supposed to work in practice? Any further insight appreciated!

[maelle]

• you create the function in any package where you want the item to appear in checklists.
• for releases you use usethis::use_release_issue() that opens an issue in the repository. An item would remind to update the allcontributors list.

[maelle]

example https://github.com/EMODnet/emodnet.wfs/blob/60ba8dc578911d3169d15f032521651ac51a898c/R/emodnet.wfs-package.R#L45

[mpadge]

Yeah, i figured it out, thanks. It's in usethis/R/release.R, where safe_pkg_env() loads current namespace. That means every package has to define one of those. I find that a bit clunky, but I guess worth documenting regardless. Thanks