Skip to content

Improve, document and group versioning code in Build.scala #21837

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

Jump to bottom
Merged
merged 3 commits into from
Nov 6, 2024
Merged

Improve, document and group versioning code in Build.scala #21837

merged 3 commits into from
Nov 6, 2024

Conversation

WojciechMazur
Copy link
Contributor

@WojciechMazur WojciechMazur commented Oct 23, 2024 •
edited
Loading

  • Introduce developedVersion describing the target for the current release cycle
  • Adapt baseVersion to the effectively revert Set baseVersion to 3.6.0 instead of 3.6.0-RC1 #21011 changes
  • Adapt .msi packager to use developedVersion as a workaround to MSI ProductInfo limitations (version without RC suffix required)
  • Group and document versioning related code

Fixes #21821
Resolves #21812

[test_msi]

@WojciechMazur
Copy link
Contributor Author

WojciechMazur commented Oct 23, 2024 •
edited
Loading

Side note: with change to Windows / version build-msi-package no longer needs to be defined with fixes RELEASEBUILD=yes. We can now try to set this value dynamically to yes only when publishing release from a tag.

Edit:
3rd commit changes build-msi to use dynamic env variable. By default it's set to RELEASEBUILD=no. Only when triggered by tag it was be set to yes

@WojciechMazur WojciechMazur force-pushed the build/improve-versions branch from d6367fd to af7ff5b Compare October 23, 2024 21:24
hamzaremmal
hamzaremmal approved these changes Nov 5, 2024
View reviewed changes
.github/workflows/build-msi.yml
# NECESSARY FLAG TO CORRECTLY CONFIGURE THE VERSION FOR SCALA
RELEASEBUILD: yes
# Release only happends when triggering CI by pushing tag
RELEASEBUILD: ${{ startsWith(github.event.ref, 'refs/tags/') && 'yes' || 'no' }}
Copy link
Member

Choose a reason for hiding this comment

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

Should be fine since the payload in the reusable workflow is inherited from the caller (See https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#workflow_call)

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've tested it in a custom repo, it worked as expected

@WojciechMazur WojciechMazur merged commit 11c957c into scala:main Nov 6, 2024
29 checks passed
@WojciechMazur WojciechMazur deleted the build/improve-versions branch November 6, 2024 10:16
@WojciechMazur WojciechMazur added the backport:nominated If we agree to backport this PR, replace this tag with "backport:accepted", otherwise delete it. label Nov 6, 2024
WojciechMazur added a commit that referenced this pull request Nov 6, 2024
@WojciechMazur
[build] Improve, document and group versioning code in Build.scala (#…
9a46653 
…21837)

* Introduce `developedVersion` describing the target for the current
release cycle
* Adapt `baseVersion` to the effectively revert #21011 changes 
* Adapt .msi packager to use `developedVersion` as a workaround to MSI
ProductInfo limitations (version without RC suffix required)
* Group and document versioning related code
[Cherry-picked 11c957c][modified]
WojciechMazur added a commit that referenced this pull request Nov 6, 2024
@WojciechMazur
[build] Improve, document and group versioning code in Build.scala (#…
a0d018c 
…21837)

* Introduce `developedVersion` describing the target for the current
release cycle
* Adapt `baseVersion` to the effectively revert #21011 changes 
* Adapt .msi packager to use `developedVersion` as a workaround to MSI
ProductInfo limitations (version without RC suffix required)
* Group and document versioning related code
[Cherry-picked 11c957c][modified]
@WojciechMazur WojciechMazur mentioned this pull request Nov 6, 2024
Closed
WojciechMazur added a commit that referenced this pull request Nov 6, 2024
@WojciechMazur
[build] Improve, document and group versioning code in Build.scala (#…
fa68fd7 
…21837)

* Introduce `developedVersion` describing the target for the current
release cycle
* Adapt `baseVersion` to the effectively revert #21011 changes 
* Adapt .msi packager to use `developedVersion` as a workaround to MSI
ProductInfo limitations (version without RC suffix required)
* Group and document versioning related code
[Cherry-picked 11c957c][modified]
WojciechMazur added a commit that referenced this pull request Nov 6, 2024
@WojciechMazur
[build] Improve, document and group versioning code in Build.scala (#…
148b10f 
…21837)

* Introduce `developedVersion` describing the target for the current
release cycle
* Adapt `baseVersion` to the effectively revert #21011 changes 
* Adapt .msi packager to use `developedVersion` as a workaround to MSI
ProductInfo limitations (version without RC suffix required)
* Group and document versioning related code
[Cherry-picked 11c957c][modified]
@WojciechMazur WojciechMazur mentioned this pull request Nov 6, 2024
Merged
WojciechMazur added a commit that referenced this pull request Nov 8, 2024
@WojciechMazur
Backport "Improve, document and group versioning code in `Build.scala…
1fd5dd1 
…` " to 3.6.2 (#21902)

Backports #21837 to the 3.6.2 branch.

PR submitted by the release tooling.
[skip ci]
@WojciechMazur WojciechMazur added backport:done This PR was successfully backported. and removed backport:nominated If we agree to backport this PR, replace this tag with "backport:accepted", otherwise delete it. labels Nov 8, 2024
@WojciechMazur WojciechMazur added this to the 3.6.2 milestone Nov 8, 2024
KacperFKorban pushed a commit to dotty-staging/dotty that referenced this pull request Nov 20, 2024
@WojciechMazur @KacperFKorban
[build] Improve, document and group versioning code in Build.scala (s…
e513538 
…cala#21837)

* Introduce `developedVersion` describing the target for the current
release cycle
* Adapt `baseVersion` to the effectively revert scala#21011 changes 
* Adapt .msi packager to use `developedVersion` as a workaround to MSI
ProductInfo limitations (version without RC suffix required)
* Group and document versioning related code
KacperFKorban pushed a commit to dotty-staging/dotty that referenced this pull request Nov 29, 2024
@WojciechMazur @KacperFKorban
[build] Improve, document and group versioning code in Build.scala (s…
812e12f 
…cala#21837)

* Introduce `developedVersion` describing the target for the current
release cycle
* Adapt `baseVersion` to the effectively revert scala#21011 changes 
* Adapt .msi packager to use `developedVersion` as a workaround to MSI
ProductInfo limitations (version without RC suffix required)
* Group and document versioning related code
@tgodzik
Copy link
Contributor

tgodzik commented Feb 14, 2025

@WojciechMazur Do we need to backport this one to LTS?

@WojciechMazur
Copy link
Contributor Author

@WojciechMazur Do we need to backport this one to LTS?

It might be useful to have these to align the release procedures between two lines, so we can try to backport this. Some of this changes can already be present in the LTS branch. There's no .msi in the LTS so changes to related CI job and Windows / version can be skipped.
We only need to be careful about the developedVersion value
There would be another PR to backport that uses these changes partially to test emitted TASTy version

WojciechMazur added a commit to WojciechMazur/dotty that referenced this pull request Mar 19, 2025
@WojciechMazur
[build] Improve, document and group versioning code in Build.scala (s…
45c2e63 
…cala#21837)

* Introduce `developedVersion` describing the target for the current
release cycle
* Adapt `baseVersion` to the effectively revert scala#21011 changes
* Adapt .msi packager to use `developedVersion` as a workaround to MSI
ProductInfo limitations (version without RC suffix required)
* Group and document versioning related code
WojciechMazur added a commit to scala/scala3-lts that referenced this pull request Mar 19, 2025
@WojciechMazur
Backport build changes and TASTy version tests from main (#185)
2b41273 
* [build] Improve, document and group versioning code in `Build.scala`  (scala#21837)

* Introduce `developedVersion` describing the target for the current
release cycle
* Adapt `baseVersion` to the effectively revert scala#21011 changes
* Adapt .msi packager to use `developedVersion` as a workaround to MSI
ProductInfo limitations (version without RC suffix required)
* Group and document versioning related code

* Improve mima test for previous version - test against first version in the series

* Document referenceVersion

* Update reference, MiMa previous version and sync TASTy version (scala#22187)

* We now document better how and when tasty version should be set
* Add additional runtime test to ensure we don't emit invalid TASTy
version during Release / NIGHTLY releases and the expected version set
in build matches version defined in TastyFormat

* Adapt `checkReleasedTastyVersion` to LTS series - nightlies of LTS are released using stable TASTy version

* Adjust expected tasty version comments to LTS versioning

* Adjust MiMaFilter for backported dotty.tools.tasty.TastyVersion class
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hamzaremmal hamzaremmal hamzaremmal approved these changes

Assignees

@WojciechMazur WojciechMazur

Labels
backport:done This PR was successfully backported.
Projects
None yet
Milestone
3.6.2
3 participants
@WojciechMazur @tgodzik @hamzaremmal