search

CLARIAH / clariah-plus

This is the project planning repository for the CLARIAH-PLUS project. It groups all technical documents and discussions pertaining to CLARIAH-PLUS in a central place and should facilitate findability, transparency and project planning, for the project as a whole.
9 stars 6 forks source link

Software version requirement #141

Open ddeboer opened 1 year ago

ddeboer commented 1 year ago

Part of Software Metadata Requirement 6 is the version number. This makes sense, but it also the software metadata’s most volatile part.

@proycon How do you feel about making the version optional in codemeta.json as long as it can be extracted from the code repository by the harvester? Or should we stick to the recommendation to use a codemeta-harvest.json instead in this case? A downside to the latter approach is that the software repository becomes more clearly dependent on the harvester in use.

proycon commented 1 year ago

How do you feel about making the version optional in codemeta.json as long as it can be extracted from the code repository by the harvester?

I see what you mean, that might be a feasible solution. The codemeta.json still describes the source code it's contained with as it's in a git repo, so the version number should be extractable from the git tag. The downside is that codemeta.json is not fully self-descriptive anymore if it relies on the harvester, like with codemeta-harvest.json. But I do see codemeta-harvest.json as a good way to provide metadata for CLARIAH and our tool discovery registry (it lowers the burden on the developer who'd otherwise have to run the harvester him/herself and put the resulting codemeta.json in the repo).