releaseNotes

[maelle]

A few questions

• It has to be something online right?

• when there is a GitHub repo

  • Should it actually point to something like https://github.com/ropensci/ropenaq/releases ?

  • Or the latest release thanks to https://developer.github.com/v3/repos/releases/#get-the-latest-release ?

• When there is no GitHub repo should it try and find the release notes at the provider e.g. https://cran.r-project.org/web/packages/HIBPwned/news.html or https://bioconductor.org/packages/release/bioc/news/a4/NEWS ?

[cboettig]

technically it can be either a URL or a URN (i.e. a namespace followed by an identifier, like ISBN:123456) collectively these are called URIs

[maelle]

For R packages could there be URN?

[maelle]

and should I try and do the updates proposed above on Monday?

[cboettig]

timing wise is up to you. Not sure what a URN would be for an R package, it would be technically valid to do cran:codemetar, but https://cran.r-project.org/package=codemetar or https://doi.org/10.5281/zenodo.1048319 would be better

[maelle]

I mean before or after the CRAN release, which is up to you 😉

[cboettig]

hah, I thought I just did what you told me to do!

Pointing to GitHub release page as first choice seems reasonable. May as well wait for this, doesn't sound like we're in a rush to get the release since jsonld change hasn't even shipped yet

[maelle]

Cool then I can pack all my badges madness into 0.1.6 😀 and add releaseNotes URL 😀

[maelle]

I'll add code to point to "general" releases page (GitHub one, and NEWS file on CRAN/BioConductor if GitHub releases page doesn't exist).

Now I guess the actual releae note related to a release, along with an ID etc. are something to be discussed in #135

[maelle]

I think it'd actually make little sense to have the general releases/NEWS page in this field since it's supposed to be the release notes of that given version.