Skip to content

Add reminder to update codemeta.json to release()?聽#1754

Description

@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()

Activity

jimhester commented on Apr 6, 2018

@jimhester
Member

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 commented on Apr 6, 2018

@maelle
ContributorAuthor

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

jimhester commented on Apr 9, 2018

@jimhester
Member

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 commented on Apr 9, 2018

@maelle
ContributorAuthor

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

jimhester commented on Apr 9, 2018

@jimhester
Member

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 commented on Apr 10, 2018

@maelle
ContributorAuthor

Fantastic, thanks!

added a commit that references this issue on Jul 18, 2018
7a69ae2

lock commented on Oct 7, 2018

@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/

locked and limited conversation to collaborators on Oct 7, 2018
added a commit that references this issue on Jul 2, 2019
4405720
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions