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

add "Nightly Versions of Scala" to Overviews page #3058

Merged
merged 13 commits into from
Sep 4, 2024
3 changes: 3 additions & 0 deletions _data/overviews.yml
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,9 @@
description: "A diverse and comprehensive set of libraries is important to any productive software ecosystem. While it is easy to develop and distribute Scala libraries, good library authorship goes beyond just writing code and publishing it. In this guide, we cover the important topic of Binary Compatibility."
icon: puzzle-piece
url: "core/binary-compatibility-for-library-authors.html"
- title: Nightly Versions of Scala
description: "We regularly publish 'nightlies' of both Scala 3 and Scala 2 so that users can preview and test the contents of upcoming releases. Here's how to find and use these versions."
url: "core/nightlies.html"

- category: "Tools"
description: "Reference material on core Scala tools like the Scala REPL and Scaladoc generation."
Expand Down
87 changes: 87 additions & 0 deletions _overviews/core/nightlies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
layout: singlepage-overview
title: Nightly Versions of Scala
permalink: /overviews/core/:title.html
---

We regularly publish nightly versions of both Scala 2 and 3 so that users can preview and test the contents of upcoming releases.

We informally call them "nightly" versions, but technically it's a misnomer. A so-called “nightly” is built for every merged PR.
SethTisue marked this conversation as resolved.
Show resolved Hide resolved

Here's how to find and use these versions.

## Scala 3

Scala 3 nightly versions are published to Maven Central. If you know the full version number of the nightly you want to use, you can use it just like any other Scala 3 version.

One quick way to get that version number is to visit https://dotty.epfl.ch and look in the upper left corner.
SethTisue marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

I'm not familiar with how this website is implemented but can we maybe add a script that scrape Maven Central and shows the latest available nightly on the website ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, I imagine we could :-)

I leave it up to you whether to open a separate PR or ticket about it.


Another way is to scrape Maven Central, as shown in this script: https://raw.githubusercontent.com/VirtusLab/community-build3/master/scripts/lastVersionNightly.sc
SethTisue marked this conversation as resolved.
Show resolved Hide resolved

A third way is to use [scala-cli](https://scala-cli.virtuslab.org), as follows.
SethTisue marked this conversation as resolved.
Show resolved Hide resolved

### scala-cli

You can run nightlies with commands such as:

scala-cli -S 3.nightly
scala-cli -S 3.3.nightly

The default command is `repl`, but all the other scala-cli subcommands such as `compile` and `run` work, too. It also works with `//>` directives in your script itself, for example:

//> using scala 3.nightly

See this [scala-cli doc page](https://scala-cli.virtuslab.org/docs/commands/compile#scala-nightlies) for details.

## Scala 2.13 or 2.12

Scala 3 nightly versions are published to a special resolver. Unless you are using scala-cli, you'll need to add that resolver to your build configuration in order to use these versions.
SethTisue marked this conversation as resolved.
Show resolved Hide resolved

### quick version (sbt)

Global / resolvers += "scala-integration" at
"https://scala-ci.typesafe.com/artifactory/scala-integration/"
Comment on lines +42 to +43
Copy link
Member

Choose a reason for hiding this comment

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

@SethTisue Do you know what's the reason behind using a custom resolver instead of Maven Central ? As Scala 3 does

Copy link
Member Author

@SethTisue SethTisue Sep 4, 2024

Choose a reason for hiding this comment

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

That decision predates me, which means it was at least 9 years ago. @lrytz might remember more. I think we felt that using up so much space on Maven Central would be excessive. Perhaps we were even wary of hitting some storage limit? Anyway, Guillaume made a different decision for Dotty.

Currently I think it's just inertia, we aren't necessarily opposed to changing it, but we aren't that motivated to change it, either.

scalaVersion := "2.13.15-bin-abcd123"

for a 2.12 nightly, substitute e.g. `2.12.20` for `2.13.15`; in either case, it's the version number of the _next_ release on that branch

for `abcd123`, manually substitute the first 7 characters of the SHA of the latest green build [on the 2.13.x or 2.12.x branch on Travis-CI](https://app.travis-ci.com/github/scala/scala/branches).
SethTisue marked this conversation as resolved.
Show resolved Hide resolved

A quick way to find out the full version number of a current nightly is to use [scala-cli](https://scala-cli.virtuslab.org), as follows.

### quick version (scala-cli)

You can run nightlies with:

scala-cli -S 2.13.nightly
scala-cli -S 2.nightly # same as 2.13.nightly
scala-cli -S 2.12.nightly

The default command is `repl`, but all the other scala-cli subcommands such as `compile` and `run` work, too. It also works with `//>` directives in your script itself, for example:

//> using scala 2.nightly
Comment on lines +52 to +62
Copy link
Member

Choose a reason for hiding this comment

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

Seems very repetitive with what the scala 3 section contain. Can we maybe merge the two of them ?

Copy link
Member Author

Choose a reason for hiding this comment

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

I did it that on purpose because I figure either someone is interested in 3, or they're interested in 2, so each section ought to be complete in itself.

Whether it's really best that way, I don't have a strong feeling about. Sounds like your feeling isn't that strong either, so let's leave it like it is for now. I wouldn't mind if it got changed in the future.


### Longer explanation

We no longer publish `-SNAPSHOT` versions of Scala 2.

But the team does publish nightly versions, each with its own fixed version number. The version number of a nightly looks like e.g. `2.13.1-bin-abcd123`. (`-bin-` signals binary compatibility to sbt; all 2.13.x releases since 2.13.0 are binary compatible with each other.)

To tell sbt to use one of these nightlies, you need to do three things.

First, add the resolver where the nightlies are kept:

Global / resolvers += "scala-integration" at
"https://scala-ci.typesafe.com/artifactory/scala-integration/"

Second, specify the Scala version:

scalaVersion := "2.13.1-bin-abcd123"

But that isn't a real version number. Manually substitute a version number containing the 7-character SHA of the last commit in the [scala/scala repository](https://github.com/scala/scala) for which a nightly version was published. Look at https://travis-ci.org/scala/scala/branches and you'll see the SHA in the upper right corner of the 2.13.x (or 2.12.x) section.
SethTisue marked this conversation as resolved.
Show resolved Hide resolved

As soon as 2.13.1 is released, the version number in the nightly will bump to 2.13.2, and so on.

If you have a multiproject build, be sure you set these settings across all projects when you modify your build definition. Or, you may set them temporarily in the sbt shell with `++2.13.1-bin-abcd123` (sbt 0.13.x) or `++2.13.1-bin-abcd123!` (sbt 1.x; the added exclamation point is necessary to force a version not included in `crossScalaVersions` to be used).

Ideally, we would suggest an automated way to ask Travis-CI for the right SHA. This is presumably possible via Travis-CI's API, but as far as we know, nobody has looked into it yet. (Is there a volunteer?)