Add reminder to update codemeta.json to release()?

[maelle]

Maybe out-of-scope feature request. 😺

Similar to #1753 could there be a reminder in release() when there's a codemeta.json in the root of the package folder?

Codemeta provide minimal metadata schemas for science software and code, in JSON-LD. They can be created via codemetar::write_codemeta()

[jimhester]

My main hesitation with this is the vast majority of packages are not going to have this. But as you mentioned I guess this reminder would only occur if a codemeta.json file is in the package; so it is probably fine.

[maelle]

Just a few code lines that I promise to maintain when needed 😉

[jimhester]

So just realized we have a mechanism for package authors to add custom release check questions by defining release_questions function in their package environment. I think this may be the best way to handle this. We could have codemetar::write_codemeta() issue a message to add this prompt to the package source the first time it is run on a package. e.g.

message(
  "* Include the following code somewhere in your package\n",
  '  release_questions <- function() "Have you updated codemeta.json with codemetar::write_codemeta()?"')

Then this question will be automatically picked up and included in the release questions for the package.

[maelle]

Oh nice! Are there some docs so that I might stop bothering you? I'm wondering how to add several questions 👼

[jimhester]

No there are no docs, but you can have the function return a character vector of questions to ask.

release_questions <- function() {
  c("Have you xyz",
     "Have you 123")
}

[maelle]

Fantastic, thanks!

[lock]

This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/