Hello, sbt-typelevel by armanbilge · Pull Request #12 · typelevel/sbt-typelevel

armanbilge · 2021-12-28T10:32:46Z

Executes #11.

Early days still, but it's solid enough to self-host and publish snapshots:
https://s01.oss.sonatype.org/content/repositories/snapshots/com/armanbilge/sbt-typelevel-ci-release_2.12_1.0/0.4-a57db49-SNAPSHOT/

If you feel empowered, please give it a try.

https://index.scala-lang.org/armanbilge/sbt-typelevel/

Highlights:

Your choice of CI snapshots: off / "true" snapshot / "stable" snapshot.
I think I fixed the double release problem in CI if you push a tag with a commit. Haven't tested this yet.
Will eventually support both passphrase and non-passphrase protected keys. ~~Support for the former is not quite ready yet,~~ ~~and haven't tested the latter~~. Confirmed to work for both!

Any and all feedback much appreciated, although it would be cool to get this merged as-is and the feedback can come in the form of issues or ideally PRs. I don't claim to have any real knowledge of what I was doing here, just tried my best 🙃

Update: published a stable hash release to maven. ~~Last step: getting keys with passphrases to work.~~ Done.

armanbilge · 2021-12-29T06:20:20Z

Alright, definitely not perfect, but overall seems to be functional :)

addSbtPlugin("com.armanbilge" % "sbt-typelevel-ci-release" % "0.4-ddf26e7")
enablePlugins(TypelevelCiReleasePlugin)

https://index.scala-lang.org/armanbilge/sbt-typelevel/

Notable features

Batteries-included: sbt-typelevel-ci-release sets you up for CI publishing MiMa-verified artifacts to sonatype under semantic versioning.
Flexible/modular: the "super-plugin" is composed of independent plugins for versioning, mima, scalac settings, gpg signing, publishing, CI, etc. Pick and choose to make your own personal super-plugin.
IMO the code is fairly straightforward. Each plugin has a well-defined responsibility. No weird inter-dependencies to keep track of and not even a taskDyn. I hope this will make contributing easy.
Support for GPG signing for keys with and without passphrases. This is determined automatically, no config required.
Opt-in snapshot publishing, either as "true" snapshots (default) or "Spiewak-style" hash-versioned releases.
No more double-publish mishaps when pushing a tagged commit. If a publish job is triggered by a commit (and not a tag) but there is a tag, it will not publish. The job triggered by the tag will publish normally.
Temurin 8 is the default JVM.
The new s01 sonatype host is the default. A single setting switches you back to the legacy host.

Full list of plugins

addSbtPlugin("com.armanbilge" % "sbt-typelevel-no-publish"          % "0.4-ddf26e7")
addSbtPlugin("com.armanbilge" % "sbt-typelevel-settings"            % "0.4-ddf26e7")
addSbtPlugin("com.armanbilge" % "sbt-typelevel-versioning"          % "0.4-ddf26e7")
addSbtPlugin("com.armanbilge" % "sbt-typelevel-mima"                % "0.4-ddf26e7")
addSbtPlugin("com.armanbilge" % "sbt-typelevel-sonatype"            % "0.4-ddf26e7")
addSbtPlugin("com.armanbilge" % "sbt-typelevel-sonatype-ci-release" % "0.4-ddf26e7")
addSbtPlugin("com.armanbilge" % "sbt-typelevel-ci-signing"          % "0.4-ddf26e7")
addSbtPlugin("com.armanbilge" % "sbt-typelevel-ci"                  % "0.4-ddf26e7")
addSbtPlugin("com.armanbilge" % "sbt-typelevel"                     % "0.4-ddf26e7")
addSbtPlugin("com.armanbilge" % "sbt-typelevel-ci-release"          % "0.4-ddf26e7")

.scalafmt.conf

CODE_OF_CONDUCT.md

build.sbt

ci-signing/build.sbt

ci/build.sbt

rossabaker · 2021-12-29T21:44:20Z

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

+
+  override def buildSettings =
+    addCommandAlias(
+      "ci",


Thought exercise: how would we make this open to extension for projects that run additional checks? This has frustrated me in other plugins that use aliases.

Oh, replaceCommandAlias?

Yep, got that here:

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

Lines 11 to 15 in f277ca9

object autoImport {

lazy val tlIsScala3 = settingKey[Boolean]("True if building with Scala 3")

def replaceCommandAlias(name: String, contents: String): Seq[Setting[State => State]] =

Seq(GlobalScope / onLoad ~= { (f: State => State) =>

f andThen { s: State =>

So much else is structured, and we manipulate aliases as semi-colon delimited strings. But I guess we inherit that from SBT's model. This is probably the best we can do.

rossabaker · 2021-12-29T21:46:28Z

core/src/main/scala/org/typelevel/sbt/TypelevelPlugin.scala

+  import GitHubActionsPlugin.autoImport._
+
+  override def globalSettings = Seq(
+    tlFatalWarningsInCi := true


I have never been particularly fond of this setting varying from local development.

True. But also, fatal warnings make development/experimentation extremely annoying.

I generally solve that by adjusting my scalacOptions in session while in that mode. That way it's consistent with CI by default, and I can opt out while hacking. But I won't die on this hill if other people like it.

Interesting. OTOH I generally solve this problem by actually paying attention to the warnings indicated in the IDE 😉

One compromise is providing a prePR command that emulates a CI compile.

I like the compromise, but I thought that was the intent of the ci alias?

I always thought of ci as what you want CI to do—run the entire test suite, run MiMa, generate docs, etc. etc. Meanwhile, prePR are "lighter-weight" checks you can do locally, e.g. formatting, compiling with fatal warnings, etc.

Hmm, this is trickier to implement than I thought.

addCommandAlias( "prePR", "; root/clean; set tlFatalWarnings := tlFatalWarningsInCi.value; +root/Test/compile")

The problem is, how do you reset tlFatalWarnings to the old setting after prePR? Not sure if this is possible, or my sbt-fu isn't good enough anyway. Someone smarter can chime in, otherwise we can shunt this for now.

It could be done with a custom task, but it may not be worth the trouble.

rossabaker · 2021-12-29T21:47:33Z

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

+
+  object autoImport {
+    lazy val tlIsScala3 = settingKey[Boolean]("True if building with Scala 3")
+    def replaceCommandAlias(name: String, contents: String): Seq[Setting[State => State]] =


Does this deserve a tl prefix since it's auto-imported?

auto-imports definitely need a prefix. The similar isDotty setting in sbt-spiewak is the reason http4s is not in the Scala 3 Community Build:

Can't add sbt-spiewak projects to the Scala 3 community build djspiewak/sbt-spiewak#83

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

versioning/src/main/scala/org/typelevel/sbt/TypelevelVersioningPlugin.scala

Co-authored-by: Ross A. Baker <ross@rossabaker.com>

armanbilge · 2021-12-30T05:45:05Z

versioning/src/main/scala/org/typelevel/sbt/TypelevelVersioningPlugin.scala

+    lazy val tlUntaggedAreSnapshots =
+      settingKey[Boolean](
+        "If true, an untagged commit is given a snapshot version, e.g. 0.4-00218f9-SNAPSHOT. If false, it is given a release version, e.g. 0.4-00218f9. (default: true)")


@rossabaker wdyt?

armanbilge · 2021-12-30T06:27:29Z

Please let me know what else is needed here so we can land this. I know there's still a lot to iterate on, but at least for me it'll be much easier to keep track of in issues and separate PRs rather than trying to track all the comments in this one. Thanks!

After this merges I'll open follow-up issues for all the unresolved comments.

armanbilge · 2021-12-30T06:36:39Z

Nice, was able to publish a snapshot under org.typelevel :)

https://oss.sonatype.org/content/repositories/snapshots/org/typelevel/sbt-typelevel_2.12_1.0/0.4-df43b10-SNAPSHOT/

armanbilge · 2021-12-30T06:37:53Z

build.sbt

+
+enablePlugins(TypelevelCiReleasePlugin)
+ThisBuild / tlCiReleaseSnapshots := true
+ThisBuild / tlCiReleaseBranches := Seq("series/armanbilge")


I'll change this before we merge, but for now lets me publish from my branch.

Suggested change

ThisBuild / tlCiReleaseBranches := Seq("series/armanbilge")

ThisBuild / tlCiReleaseBranches := Seq("main")

armanbilge · 2021-12-30T14:54:16Z

Darn, I'll have to rollback the s01 default. https://github.com/typelevel/general/issues/114#issuecomment-1003058561

rossabaker

I don't think there are any showstoppers here. I'll give the snapshot a try on a lower-profile project.

armanbilge · 2021-12-30T17:19:15Z

main just published as https://oss.sonatype.org/content/repositories/snapshots/org/typelevel/sbt-typelevel-ci-release_2.12_1.0/0.4-60549ca-SNAPSHOT/sbt-typelevel-ci-release-0.4-60549ca-SNAPSHOT.pom

armanbilge added 30 commits December 25, 2021 17:52

Start afresh

6558c7c

Create NoPublishPlugin

3077a90

we are self-hosting!

035cc79

Use no-publish on root actually :)

98e2e74

typo

b21d41c

Setup basic versioning

570c496

Setup a mima and settings plugins

d864c0e

Better variable name

b3cd73e

Start working on the mima plugin

f379386

Some progress on mima

c6d2fdf

Add model for version

4e6606b

MiMa plugin seems good

7198a8d

Start working on settings plugin

657e7d1

ScalaJS settings depend on TL settings

069bcee

Add more settings

f195ffb

Bump sbt, setup scalafmt

b87e2d6

Setup ScmInfo setting

135f0c0

Use V model for versioning plugin

0fdd453

Distance-based versioning

cc1acda

Setup sonatype plugin

f0eafbe

Clarify bundle release logic

2a1b5eb

Setup ci-release plugin

90b37cb

Supppress warnings

74ed1fc

Add failsafe for tag/push double-publish

5d8cfed

Setup ci-signing plugin

ef3fa08

Create CI plugin

df39173

Version scheme is early-semver

f87c5ca

Generate workflow

de610ab

Bikeshedding

93e4d7b

Create kernel plugin

5ad198e

armanbilge added 7 commits December 29, 2021 01:56

Finish up passphrase-stripping impl

01e80ea

Regenerate workflow

bedf652

Bikeshedding

775c4c8

Fix mima artifacts

1f37022

Bump back base version, woops

49d5d54

Adjust version comparator for new scheme

6c3d633

Clearer variable names

95ee54d

Tweak mima interpretation of current

ddf26e7

rossabaker reviewed Dec 29, 2021

View reviewed changes

armanbilge and others added 4 commits December 29, 2021 17:08

Update CODE_OF_CONDUCT.md

f277ca9

Co-authored-by: Ross A. Baker <ross@rossabaker.com>

Thin the default ci matrix

53f42e4

Update the developer list

00218f9

Try to clarify snapshot setting

02972dd

armanbilge commented Dec 30, 2021

View reviewed changes

armanbilge added 2 commits December 30, 2021 05:51

Try out my publishing rights

2c2149a

Try legacy host?

df43b10

armanbilge requested a review from rossabaker December 30, 2021 06:25

armanbilge commented Dec 30, 2021

View reviewed changes

Don't use s01 by default

44d1f98

rossabaker approved these changes Dec 30, 2021

View reviewed changes

Update the main branch

a0c87a0

armanbilge merged commit 60549ca into typelevel:main Dec 30, 2021

armanbilge mentioned this pull request Dec 30, 2021

prePR command—or another solution to fatal-warnings-in-CI #15

Closed

armanbilge mentioned this pull request Feb 3, 2022

Prereleases come before releases #135

Closed

armanbilge mentioned this pull request Apr 4, 2022

sbt-typelevel adoption #83

Open

44 tasks

	object autoImport {
	lazy val tlIsScala3 = settingKey[Boolean]("True if building with Scala 3")
	def replaceCommandAlias(name: String, contents: String): Seq[Setting[State => State]] =
	Seq(GlobalScope / onLoad ~= { (f: State => State) =>
	f andThen { s: State =>

	ThisBuild / tlCiReleaseBranches := Seq("series/armanbilge")
	ThisBuild / tlCiReleaseBranches := Seq("main")

Uh oh!

Conversation

armanbilge commented Dec 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

armanbilge commented Dec 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notable features

Full list of plugins

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

armanbilge commented Dec 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

armanbilge commented Dec 30, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

armanbilge commented Dec 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rossabaker left a comment

Choose a reason for hiding this comment

Uh oh!

armanbilge commented Dec 30, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

armanbilge commented Dec 28, 2021 •

edited

Loading

armanbilge commented Dec 29, 2021 •

edited

Loading

armanbilge commented Dec 30, 2021 •

edited

Loading

armanbilge commented Dec 30, 2021 •

edited

Loading