Skip to content

Bump version of reference documentation to 3.1.3 #15600

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 7, 2022
Merged

Bump version of reference documentation to 3.1.3 #15600

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion project/Build.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1413,7 +1413,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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that the // TODO gives a more future-proof solution, no?

Copy link
Contributor Author

@Kordyjan Kordyjan Jul 6, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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…

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After merging this PR, we should merge main into language-reference-stable and everything should be fine

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

.remove[VersionsDictionaryUrl]
.add(SourceLinks(List(
s"${temp.getAbsolutePath}=github://lampepfl/dotty/language-reference-stable"
Expand Down