Skip to content

Commit 0da708b

Browse files
authored
Merge pull request #109 from lrytz/tag-with-scala-version
Allow building an existing tag against a new Scala version
2 parents eb5bc9a + 26d971a commit 0da708b

File tree

5 files changed

+92
-67
lines changed

5 files changed

+92
-67
lines changed

admin/README.md

+40-28
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
## Tag Driven Releasing
22

3-
Copied from https://github.com/scala/scala-java8-compat/commit/4a6cfc97cd95227b86650410e1b632e5ff79335b.
4-
53
### Background Reading
64

75
- http://docs.travis-ci.com/user/environment-variables/
@@ -14,47 +12,61 @@ To configure tag driven releases from Travis CI.
1412

1513
1. Generate a key pair for this repository with `./admin/genKeyPair.sh`.
1614
Edit `.travis.yml` and `admin/build.sh` as prompted.
17-
2. Publish the public key to https://pgp.mit.edu
18-
3. Store other secrets as encrypted environment variables with `admin/encryptEnvVars.sh`.
15+
1. Publish the public key to https://pgp.mit.edu
16+
1. Store other secrets as encrypted environment variables with `admin/encryptEnvVars.sh`.
1917
Edit `.travis.yml` as prompted.
20-
4. Edit `.travis.yml` to use `./admin/build.sh` as the build script,
18+
1. Edit `.travis.yml` to use `./admin/build.sh` as the build script,
2119
and edit that script to use the tasks required for this project.
22-
5. Edit `build.sbt` to select which JDK will be used for publishing.
20+
1. Edit `build.sbt`'s `scalaVersionsByJvm in ThisBuild` to select Scala and JVM version
21+
combinations that will be used for publishing.
2322

24-
It is important to add comments in .travis.yml to identify the name
23+
It is important to add comments in `.travis.yml` to identify the name
2524
of each environment variable encoded in a `:secure` section.
2625

27-
After all of these steps, your .travis.yml should contain config of the
28-
form:
26+
After these steps, your `.travis.yml` should contain config of the form:
27+
28+
```
29+
language: scala
30+
31+
env:
32+
global:
33+
# PGP_PASSPHRASE
34+
- secure: "XXXXXX"
35+
# SONA_USER
36+
- secure: "XXXXXX"
37+
# SONA_PASS
38+
- secure: "XXXXXX"
39+
40+
script: admin/build.sh
2941
30-
language: scala
31-
env:
32-
global:
33-
# PGP_PASSPHRASE
34-
- secure: "XXXXXX"
35-
# SONA_USER
36-
- secure: "XXXXXX"
37-
# SONA_PASS
38-
- secure: "XXXXXX"
39-
script: admin/build.sh
42+
jdk:
43+
- openjdk6
44+
- oraclejdk8
45+
46+
notifications:
47+
email:
48+
49+
```
4050

4151
If Sonatype credentials change in the future, step 3 can be repeated
4252
without generating a new key.
4353

44-
Be sure to use SBT 0.13.7 or higher to avoid [#1430](https://github.com/sbt/sbt/issues/1430)!
45-
4654
### Testing
4755

48-
1. Follow the release process below to create a dummy release (e.g. 0.1.0-TEST1).
56+
1. Follow the release process below to create a dummy release (e.g., `v0.1.0-TEST1`).
4957
Confirm that the release was staged to Sonatype but do not release it to Maven
5058
central. Instead, drop the staging repository.
5159

5260
### Performing a release
5361

54-
1. Create a GitHub "Release" (with a corresponding tag) via the GitHub
62+
1. Create a GitHub "Release" with a corresponding tag (e.g., `v0.1.1`) via the GitHub
5563
web interface.
56-
2. Travis CI will schedule a build for this release. Review the build logs.
57-
3. Log into https://oss.sonatype.org/ and identify the staging repository.
58-
4. Sanity check its contents
59-
5. Release staging repository to Maven and send out release announcement.
60-
64+
1. The release will be published using the Scala and JVM version combinations specified
65+
in `scalaVersionsByJvm` in `build.sbt`.
66+
- If you need to release against a different Scala version, include the Scala version
67+
and the JVM version to use in the tag name, separated by `#`s (e.g., `v0.1.1#2.13.0-M1#8`).
68+
Note that the JVM version needs to be listed in `.travis.yml` for the build to run.
69+
1. Travis CI will schedule a build for this release. Review the build logs.
70+
1. Log into https://oss.sonatype.org/ and identify the staging repository.
71+
1. Sanity check its contents.
72+
1. Release staging repository to Maven and send out release announcement.

admin/build.sh

+36-8
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,43 @@
22

33
set -e
44

5-
# prep environment for publish to sonatype staging if the HEAD commit is tagged
5+
# Builds of tagged revisions are published to sonatype staging.
66

7-
# git on travis does not fetch tags, but we have TRAVIS_TAG
8-
# headTag=$(git describe --exact-match ||:)
7+
# Travis runs a build on new revisions and on new tags, so a tagged revision is built twice.
8+
# Builds for a tag have TRAVIS_TAG defined, which we use for identifying tagged builds.
9+
# Checking the local git clone would not work because git on travis does not fetch tags.
10+
11+
# The version number to be published is extracted from the tag, e.g., v1.2.3 publishes
12+
# version 1.2.3 using all Scala versions in build.sbt's `crossScalaVersions`.
13+
14+
# When a new, binary incompatible Scala version becomes available, a previously released version
15+
# can be released using that new Scala version by creating a new tag containing the Scala and the
16+
# JVM version after hashes, e.g., v1.2.3#2.13.0-M1#8. The JVM version needs to be listed in
17+
# `.travis.yml`, otherwise the required build doesn't run.
18+
19+
verPat="[0-9]+\.[0-9]+\.[0-9]+(-[A-Za-z0-9-]+)?"
20+
tagPat="^v$verPat(#$verPat#[0-9]+)?$"
21+
22+
if [[ "$TRAVIS_TAG" =~ $tagPat ]]; then
23+
currentJvmVer=$(java -version 2>&1 | awk -F '"' '/version/ {print $2}' | sed 's/^1\.//' | sed 's/[^0-9].*//')
24+
25+
tagVer=$(echo $TRAVIS_TAG | sed s/#.*// | sed s/^v//)
26+
publishVersion='set every version := "'$tagVer'"'
27+
28+
scalaAndJvmVer=$(echo $TRAVIS_TAG | sed s/[^#]*// | sed s/^#//)
29+
if [ "$scalaAndJvmVer" != "" ]; then
30+
scalaVer=$(echo $scalaAndJvmVer | sed s/#.*//)
31+
jvmVer=$(echo $scalaAndJvmVer | sed s/[^#]*// | sed s/^#//)
32+
if [ "$jvmVer" != "$currentJvmVer" ]; then
33+
echo "Not publishing $TRAVIS_TAG on Java version $currentJvmVer."
34+
exit 0
35+
fi
36+
publishScalaVersion='set every ScalaModulePlugin.scalaVersionsByJvm := Map('$jvmVer' -> List("'$scalaVer'" -> true))'
37+
echo "Releasing $tagVer using Scala $scalaVer on Java version $jvmVer."
38+
else
39+
echo "Releasing $tagVer on Java version $currentJvmVer according to 'scalaVersionsByJvm' in build.sbt."
40+
fi
941
10-
if [[ "$TRAVIS_TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-[A-Za-z0-9-]+)? ]]; then
11-
echo "Going to release from tag $TRAVIS_TAG!"
12-
myVer=$(echo $TRAVIS_TAG | sed -e s/^v//)
13-
publishVersion='set every version := "'$myVer'"'
1442
extraTarget="+publish-signed"
1543
cat admin/gpg.sbt >> project/plugins.sbt
1644
cp admin/publish-settings.sbt .
@@ -22,4 +50,4 @@ if [[ "$TRAVIS_TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-[A-Za-z0-9-]+)? ]]; then
2250
openssl aes-256-cbc -K $K -iv $IV -in admin/secring.asc.enc -out admin/secring.asc -d
2351
fi
2452
25-
sbt "$publishVersion" clean update +test +publishLocal $extraTarget
53+
sbt "$publishVersion" "$publishScalaVersion" clean update +test +publishLocal $extraTarget

build.sbt

+13-28
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,16 @@
1-
scalaVersion in ThisBuild := crossScalaVersions.value.head
1+
import ScalaModulePlugin._
22

3-
crossScalaVersions in ThisBuild := {
4-
val v211 = List("2.11.8")
5-
val v212 = List("2.12.1")
3+
scalaVersionsByJvm in ThisBuild := {
4+
val v211 = "2.11.11"
5+
val v212 = "2.12.2"
6+
val v213 = "2.13.0-M1"
67

7-
val javaVersion = System.getProperty("java.version")
8-
val isTravisPublishing = !util.Properties.envOrElse("TRAVIS_TAG", "").trim.isEmpty
9-
10-
if (isTravisPublishing) {
11-
if (javaVersion.startsWith("1.6.")) v211
12-
else if (javaVersion.startsWith("1.8.")) v212
13-
else Nil
14-
} else if (javaVersion.startsWith("1.6.") || javaVersion.startsWith("1.7.")) {
15-
v211
16-
} else if (javaVersion.startsWith("1.8.") || javaVersion.startsWith("9")) {
17-
v211 ++ v212
18-
} else {
19-
sys.error(s"Unsupported java version: $javaVersion.")
20-
}
8+
Map(
9+
6 -> List(v211 -> true),
10+
7 -> List(v211 -> false),
11+
8 -> List(v212 -> true, v213 -> true, v211 -> false),
12+
9 -> List(v212 -> false, v213 -> false, v211 -> false)
13+
)
2114
}
2215

2316
lazy val `scala-parser-combinators` = crossProject.in(file(".")).
@@ -44,22 +37,14 @@ lazy val `scala-parser-combinators` = crossProject.in(file(".")).
4437
name := "scala-parser-combinators"
4538
).
4639
jsSettings(
47-
name := "scala-parser-combinators-js",
48-
scalaJSUseRhino := true
40+
name := "scala-parser-combinators-js"
4941
).
5042
settings(
5143
moduleName := "scala-parser-combinators",
5244
version := "1.0.6-SNAPSHOT"
5345
).
5446
jvmSettings(
55-
// important!! must come here (why?)
56-
scalaModuleOsgiSettings: _*
57-
).
58-
jvmSettings(
59-
OsgiKeys.exportPackage := Seq(s"scala.util.parsing.*;version=${version.value}"),
60-
61-
// needed to fix classloader issues (see scala-xml#20)
62-
fork in Test := true
47+
OsgiKeys.exportPackage := Seq(s"scala.util.parsing.*;version=${version.value}")
6348
).
6449
jsSettings(
6550
// Scala.js cannot run forked tests

project/build.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
sbt.version=0.13.13
1+
sbt.version=0.13.15

project/plugins.sbt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
addSbtPlugin("org.scala-lang.modules" % "scala-module-plugin" % "1.0.4")
1+
addSbtPlugin("org.scala-lang.modules" % "scala-module-plugin" % "1.0.8")
22

3-
addSbtPlugin("org.scala-js" % "sbt-scalajs" % "0.6.13")
3+
addSbtPlugin("org.scala-js" % "sbt-scalajs" % "0.6.16")

0 commit comments

Comments
 (0)