Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jdhoffa opened this issue Mar 26, 2024 · 2 comments
Open

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

jdhoffa opened this issue Mar 26, 2024 · 2 comments

Comments

@jdhoffa
Copy link
Member

jdhoffa commented Mar 26, 2024

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
Copy link
Contributor

@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
Copy link
Member Author

jdhoffa commented Mar 27, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants