Introduce `tlCrossRootProject` #43

armanbilge · 2022-01-04T03:33:09Z

Fixes #34.

This introduces a tlCrossRootProject helper for creating the "root" aggregate project. It:

Generates root, rootJVM, rootJS, and rootNative projects (all set to no-publish)
Automatically sorts any aggregated projects and cross-projects into their appropriate roots (root itself collects everything)
Adds an axis to the CI matrix for platform, but only adds jobs for platforms which are represented in the build

I've demonstrated/tested tlCrossRootProject on this build, where it adds a single ciJVM job to the matrix since there are no JS or native project in this build. (Note that we now also have a rootJS and rootNative project that are empty, just a small nuisance I hope.)

armanbilge · 2022-01-04T03:35:23Z

build.sbt

+lazy val root = tlCrossRootProject.aggregate(
+  kernel,
+  noPublish,
+  settings,
+  github,
+  versioning,
+  mima,
+  sonatype,
+  ciSigning,
+  sonatypeCiRelease,
+  ci,
+  core,
+  ciRelease)


Here it is in action. Nothing fancy. Regardless of the name of the val it's assigned to, it always generates projects called root—I didn't want to fuss with macros.

armanbilge · 2022-01-04T03:38:39Z

ci/build.sbt

+addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.0.0") // scala-steward:off
+addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.4.0") // scala-steward:off


Since the CI plugin is trying not to be too prescriptive, and we don't use the JS/native plugins except to check for their presence on a project, these versions should be sufficient.

Hopefully this won't interfere with our other updates.

Does the Native plugin have have the non-breaking track record of Scala.js? What is the risk of this dependency to all the people who don't aspire to support Native, which I think is still most Typelevel projects?

All fair points, I'm not familiar enough with native but it's still much more in development. In any case, I ended up removing it because my plugin detection idea wasn't working. See #43 (comment).

armanbilge · 2022-01-04T04:23:16Z

ci/src/main/scala/org/typelevel/sbt/CrossRootProject.scala

+
+  private def aggregateImpl(projects: Project*): CrossRootProject = {
+
+    val jsProjects = projects.filter(p => Plugins.satisfied(p.plugins, Set(ScalaJSPlugin)))


Hmm, these filters don't work like I ~~expected~~ wanted them to—Plugins.satisfied is too strict.

armanbilge · 2022-01-04T04:35:08Z

ci/src/main/scala/org/typelevel/sbt/CrossRootProject.scala

+    val jsProjects =
+      projects.filter(_.plugins.toString.contains("org.scalajs.sbtplugin.ScalaJSPlugin"))
+
+    val nativeProjects =
+      projects.filter(
+        _.plugins.toString.contains("scala.scalanative.sbtplugin.ScalaNativePlugin"))


Too horrible?

rossabaker

I like to minimize how much users need to think about cross-platform, but I'm worried that extra dependenare going to make it hard for the typical project that just wants an easy way to publish for the JVM.

rossabaker · 2022-01-04T04:52:04Z

ci/build.sbt

+addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.0.0") // scala-steward:off
+addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.4.0") // scala-steward:off


Does the Native plugin have have the non-breaking track record of Scala.js? What is the risk of this dependency to all the people who don't aspire to support Native, which I think is still most Typelevel projects?

armanbilge · 2022-01-04T05:05:08Z

Yeah, that's a fair point. I agree we should leave dependencies to native out, but SJS I think is stable enough?

Alternatively, all of this could be moved to separate plugins actually: sbt-typelevel-ci-cross for tlCrossRootProject and one more super-plugin sbt-typelevel-cross on top of sbt-typelevel.

rossabaker · 2022-01-04T05:17:06Z

I fear heading for 2^n plugins for n supported use cases. What is the approximate burden on a JVM-only project if the Scala.js machinery is present?

armanbilge · 2022-01-04T05:19:07Z

Just the Scala.js plugin on the sbt classpath. They can ignore this tlCrossRootProject thing, it's completely opt-in.

Edit: oh, I also put sbt-crossproject on the sbt classpath (this is another stable one I think). But this is not really necessary: I just added it as part of the catch-all superplugin.

armanbilge · 2022-01-04T15:37:30Z

kernel/src/main/scala/org/typelevel/sbt/TypelevelKernelPlugin.scala

      Seq(GlobalScope / onLoad ~= { (f: State => State) =>
        f andThen { s: State =>
          BasicCommands.addAlias(BasicCommands.removeAlias(s, name), name, contents)
        }
      })
+
+    implicit def tlCommandOps(commands: List[String]): TlCommandOps = new TlCommandOps(commands)


I know implicits aren't the most popular. Thoughts on this mkCommand syntax to help define the aliases?

I don't think this one does enough to justify the magic. If we frequently stubbed our toe quoting semi-colons, maybe, but we don't, and the helper doesn't fix that anyway.

Fair enough, I'll scrap it.

armanbilge · 2022-01-04T15:40:04Z

These latest changes try to DRY the command alias stuff, since we end up with many more of these to handle ciJVM, ciJS, etc.

rossabaker

We need to try this on an application, where cross-platform doesn't tend to be needed, and make sure that none of this interferes. But it seems reasonable.

armanbilge · 2022-01-07T22:57:54Z

Agree on testing 👍

If I've done it right, it shouldn't interfere because the TypelevelCiCrossPlugin and TypelevelCi{JS,JVM,Native}Plugin are all so-called noTrigger plugins, i.e. they will only be activated if enabled explicitly. And that only happens if a tlCrossRootProject is created. Otherwise, everything here should sit dormant.

armanbilge · 2022-02-06T23:13:26Z

This PR solved sbt/sbt-github-actions#3.

armanbilge added 7 commits January 4, 2022 02:09

Create CrossRootProject

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

ccfe743

Add tlCrossRootProject to autoimport

7c84e08

Remove cross-project dependency

79a97c1

Relocate target dir hack

26dc906

Dog-food the cross-root-project

d03efeb

Fix for TL projects with crossed CI

3f2a2ee

Comment

cd958a6

armanbilge commented Jan 4, 2022

View reviewed changes

Only run JS/native with default Java

6ec05ed

armanbilge commented Jan 4, 2022

View reviewed changes

armanbilge marked this pull request as draft January 4, 2022 04:23

Fix plugin detection

d97d3c4

armanbilge commented Jan 4, 2022

View reviewed changes

armanbilge marked this pull request as ready for review January 4, 2022 04:35

rossabaker reviewed Jan 4, 2022

View reviewed changes

Remove native dependency from core

5233ca9

armanbilge added 4 commits January 4, 2022 15:16

Add command alias helper and get dry

e45101f

replaceCommandAlias -> tlReplaceCommandAlias

a286c96

Better handling of per-platform ci commands

45d3023

Simplifying

c9081ba

armanbilge commented Jan 4, 2022

View reviewed changes

armanbilge added 3 commits January 5, 2022 19:23

Remove command ops syntax

3e7cffe

Make target workaround more robust

c297047

Remove unused import

dc19f27

rossabaker approved these changes Jan 7, 2022

View reviewed changes

armanbilge merged commit 72a0452 into typelevel:main Jan 7, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce `tlCrossRootProject` #43

Introduce `tlCrossRootProject` #43

armanbilge commented Jan 4, 2022

armanbilge Jan 4, 2022

armanbilge Jan 4, 2022

rossabaker Jan 4, 2022

armanbilge Jan 4, 2022

armanbilge Jan 4, 2022

armanbilge Jan 4, 2022

rossabaker left a comment

rossabaker Jan 4, 2022

armanbilge commented Jan 4, 2022

rossabaker commented Jan 4, 2022

armanbilge commented Jan 4, 2022 •

edited

Loading

armanbilge Jan 4, 2022

rossabaker Jan 5, 2022

armanbilge Jan 5, 2022

armanbilge commented Jan 4, 2022

rossabaker left a comment

armanbilge commented Jan 7, 2022

armanbilge commented Feb 6, 2022

		addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.0.0") // scala-steward:off
		addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.4.0") // scala-steward:off


		private def aggregateImpl(projects: Project*): CrossRootProject = {

		val jsProjects = projects.filter(p => Plugins.satisfied(p.plugins, Set(ScalaJSPlugin)))

Introduce tlCrossRootProject #43

Introduce tlCrossRootProject #43

Conversation

armanbilge commented Jan 4, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rossabaker left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

armanbilge commented Jan 4, 2022

rossabaker commented Jan 4, 2022

armanbilge commented Jan 4, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

armanbilge commented Jan 4, 2022

rossabaker left a comment

Choose a reason for hiding this comment

armanbilge commented Jan 7, 2022

armanbilge commented Feb 6, 2022

Introduce `tlCrossRootProject` #43

Introduce `tlCrossRootProject` #43

armanbilge commented Jan 4, 2022 •

edited

Loading