Bump version of reference documentation to 3.1.3 #15600
Conversation
| @@ -1423,7 +1423,7 @@ object Build { | |||
| .add(OutputDir("scaladoc/output/reference")) | |||
| .add(SiteRoot(s"${temp.getAbsolutePath}/docs")) | |||
| .add(ProjectName("Scala 3 Reference")) | |||
| .add(ProjectVersion("3.1.2")) // TODO: Change that later to the current version tag. (This must happen on first forward this branch to stable release tag) | |||
| .add(ProjectVersion("3.1.3")) // TODO: Change that later to the current version tag. (This must happen on first forward this branch to stable release tag) | |||
There was a problem hiding this comment.
It seems that the // TODO gives a more future-proof solution, no?
There was a problem hiding this comment.
I'm not really sure how to understand the //TODO:. If I'm not mistaken reference documentation is re-published every time something changes inside of it. If we use the baseVersion here, documentation will always display some unreleased RC version. previousDottyVersion should work, as it is changed on main just after every release, but I'm not yet sure.
There was a problem hiding this comment.
I think you should consider adding more documentation about how the documentation itself is published because it is not so simple and we get confused. As far as I understand, only the branch language-reference-stable is periodically built to produce the Scala 3 reference at https://docs.scala-lang.org/scala3/reference. I think there should be a step in the release process that consists of merging main to language-reference-stable so that baseVersion (or maybe another variable?) gets updated in the language-reference-stable branch with the right number. It could be done differently, maybe…
There was a problem hiding this comment.
After merging this PR, we should merge main into language-reference-stable and everything should be fine
There was a problem hiding this comment.
I now understand how it should be handled. Next time we will take care of the doc version during the release procedure.
To have a short-time fix, I will change the base of this PR to the stable release branch. This way there is no risk that we may contaminate stable documentation with things that are meant for 3.2.
Kordyjan
force-pushed
the
doc-version-3.1.3
branch
from
1360dee to
df3c566
Compare
|
Thank you! However, I would like to insist on the fact that I believe it would be great to document somewhere the branching model, and the process to manage the documentation. |
Fixes #15598