Read the most recent version for the docs from the Changelog #911
Conversation
| "VERSION" -> | ||
| // This is reading the most recent header from the CHANGELOG that looks like a version, assuming that's the most | ||
| // recent version to refer to in the docs. | ||
| IO.readLines(file("CHANGELOG.md")).flatMap("""^## \[([0-9.]+)\]""".r.findFirstMatchIn).head.group(1) |
There was a problem hiding this comment.
I am fine with this approach. But as food for thought, could we reason about the returned value in comparison to what's in version.sbt? It would be nice to be able to catch an error like a wrong header in the md file.
There was a problem hiding this comment.
Maybe, but that's hard to solve in general because version.sbt holds the "current" version and this VERSION should include the last published version, so we would need some mechanism able to compare versions (assuming a scheme and snapshot versions). Since an update to this VERSION variable results in an update to the README, I think mistakes are easy to spot as is.
There was a problem hiding this comment.
Precisely, I was thinking about a semantic check, e.g. look for patch/minor/major bump. But anyway. I think it's perfectly fine this way and a great improvement.
2 participants
This pull request proposes fetching the most recent version we refer to the in the README from the most recent header in the Changelog. We frequently forget to update the
VERSIONmdoc variable so I think this helps to keep things in sync.Does this change relate to existing issues or pull requests?
No.
Does this change require an update to the documentation?
This is an update to the documentation.
How has this been tested?
I manually executed
docs/mdocand made sure theVERSIONvariable was properly filled, resulting in the update toREADME.mdincluded in this pull request.