Releases: ropensci/codemetar
codemetar 0.3.0
write_codemetar()
can now be called from anywhere within a package directory structure. (#305, @mpadge)- Breaking change:
write_codemeta()
writes the JSON file atpath
relative topkg
, not the current directory. (#303, @ThierryO) - Added documentation for changing the default branch (#302, @jonkeane)
- Breaking change: Relatedly, it is no longer possible to use
write_codemeta()
on an installed packages, in that case one would have to usecreate_codemeta()
together withjsonlite::write_json()
. - Use R.Version() instead of R.version to allow mocking in tests.
- Bug fix: now able to parse a README where badges are in a table with non badges links.
- Bug fix:
guess_fileSize()
properly handles.Rbuildignore
(#299, @ThierryO). - Bug fix:
create_codemetar()
handles minimal packages (#298, @ThierryO).
v0.1.9
codemetar: Generate CodeMeta Metadata for R Packages
Bugfix release: patch test suite to execute conditionally based on internet availability.
codemetar: Generate CodeMeta Metadata for R Packages
New in 0.1.7
2018-12
-
jsonld
that is used only incrosswalk()
andcodemeta_validate()
is now an optional dependency (Suggests rather than Imports). -
The CodeRepository URL is now cleaned a bit (removing direct link to the README).
-
write_codemeta()
gains a new argumentuse_githook
to make the creation of a DESCRIPTION/codemeta.json git pre-commit hook optional. -
create_codemeta()
andwrite_codemeta()
gain a new argumentuse_filesize
to make the building of the package to get its size optional. -
Encoding bug fixed in
extract_badges()
. -
extract_badges()
now usescommonmark
andxml2
instead of only regular expressions. -
pkgbuild
is now used directly instead ofdevtools
. -
give_opinion()
now recognizes lifecycle badges, not only repostatus.org badges.
codemetar: Generate CodeMeta Metadata for R Packages
-
New functions
-
extract_badges for extracting information from all badges in a Markdown file.
-
give_opinion giving opiniated advice about package metadata
-
-
Changes to the create_codemeta output
-
relatedLink field now include provider URL and URL(s) from DESCRIPTION that are not the code repository
-
maintainer is now a list allowing for several maintainers since e.g. the BioConductor a4 package has two maintainers.
-
if more than one CI service among Travis, Appveyor and Circle CI are used and shown via a README badge they're all added to the contIntegration field. URLs from codecov and coveralls badges are also added to the contIntegration field.
-
repo status inferred from the README now 1) is an URL instead of a word 2) recognizes either repostatus.org or Tidyverse lifecycle badges.
-
if present, priority is given to the Repository and BugReports fields of DESCRIPTION for filling the codeRepository and issueTracker fields of codemeta.json (which means working on a fork won't change these).
-
ability to parse all CRAN-allowed MARC roles.
-
if there is a badge for an rOpenSci onboarding review and the review issue is closed, basic review metadata is added to codemeta.json
-
For dependencies, if the provider guessed is CRAN or BioConductor, their canonic CRAN/BioConductor URL is added to codemeta.json as sameAs, unless there's a GitHub repo mentioned for them in Remotes in DESCRIPTION, in which case sameAs is that GitHub repo.
-
CRAN is now correctly translated as "Comprehensive R Archive Network"
-
If codeRepository is guessed to be a GitHub repo (via the URL field of DESCRIPTION or via git remote URL), the repo topics are queried via GitHub API V3 and added to the keywords (in combination with keywords stored in the X-schema.org-keywords field of DESCRIPTION)
-
SystemRequirements are now parsed using https://sysreqs.r-hub.io/, outputting URLs then stored in softwareRequirements
-
-
Help to remind to update codemeta.json regularly: Writing codemeta.json for the first time adds a git pre-commit hook and suggests adding a release question for devtools::release.
-
Internal changes
-
Now uses desc to parse DESCRIPTION files.
-
Package license changed to GPL because of code borrowed from usethis
-
Uses crul instead of httr and uses crul to check some URLs.
-
write_codemeta only uses Rbuildignore and a pre-commit git hook if the function is called from a package folder directly and with the path argument equal to "codemeta.json"
-
The calls to available.packages() for guess_provider now happen inside memoised functions.
-
codemeta_readme function.
-
codemetar: : Generate 'CodeMeta' Metadata for R Packages
codemetar: Generate CodeMeta Metadata for R Packages
0.1.2 Update NEWS.md
codemetar: Generate CodeMeta Metadata for R Packages
The Codemeta Project defines a JSON-LD format for describing software metadata, as detailed at https://codemeta.github.io. This package provides utilities to generate, parse, and modify codemeta.jsonld
files automatically for R packages, as well as tools and examples for working with codemeta JSON-LD more generally.
codemetar: Generate CodeMeta Metadata for R Packages
The 'Codemeta' Project defines a JSON-LD format for describing software metadata, as detailed at https://codemeta.github.io. This package provides utilities to generate, parse, and modify codemeta.jsonld
files automatically for R packages, as well as tools and examples for working with codemeta JSON-LD more generally.