search

RMI-PACTA / actions

Actions for GitHub workflows
4 stars 0 forks source link

feat: `R-semver-check.yml` gains check for `NEWS.md` #72

Open jdhoffa opened 7 months ago

jdhoffa commented 7 months ago

In particular, I think that (in pseudo-code) we want something like:

if (version == "X.Y.Z") 
   header(NEWS.md) contains "X.Y.Z"
else if (version == "X.Y.Z.9...")
   header(NEWS.md) contains "development version"

In the wild this looks like: r2dii.analysis v0.3.0.9000: https://github.com/RMI-PACTA/r2dii.analysis/blob/6d0aa8df211ab2ac9d6fa6af3daf73ba2ce4e507/NEWS.md

r2dii.analysis v0.4.0: https://github.com/RMI-PACTA/r2dii.analysis/blob/8391b83325a1657ca4861387ee84c1654959a101/NEWS.md

AlexAxthelm commented 7 months ago

@jdhoffa Should we throw an error if NEWS.md does not exist, or accept that and pass the check?

I think we should be checking for existence of that file somewhere, but I think that is only necessary for repos further along in the SDLC.

jdhoffa commented 7 months ago

I imagine from version 0.1.0 onward we want a NEWS.md file probably? or alternatively from 1.0.0 onwrad?

Happy to discuss, but agree that NEWS.md need only exist once the repo is further along