Skip to content

README: document sbt 1.x vs sbt 2.x version split#622

Merged
xerial merged 1 commit into
mainfrom
readme-and-version-bump
Jun 16, 2026
Merged

README: document sbt 1.x vs sbt 2.x version split#622
xerial merged 1 commit into
mainfrom
readme-and-version-bump

Conversation

@xerial

@xerial xerial commented Jun 16, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a version-matrix table to the README's Usage section so users know which sbt-pack version to pin for their sbt version.
  • Replaces the outdated // for sbt-0.13.x, sbt-1.x plugins.sbt snippet with two distinct snippets: 1.x.y for sbt 2, 0.23.x for sbt 1.
  • Points sbt 1 users at the sbt-1 maintenance branch.

About the 1.0.0 release

This PR only updates docs. The major bump itself is a release-tag action:

```
git tag v1.0.0
git push --tags
```

That triggers the existing release workflow (it runs on v* tags) and publishes 1.0.0 to Maven Central. Since the project uses sbt-dynver, no version field in build.sbt needs to change — the tag is the source of truth.

Test plan

  • Markdown renders correctly (table + code blocks)

🤖 Generated with Claude Code

Add a version-matrix table and updated plugins.sbt snippet so users on
sbt 1.x know to pin to `0.23.x` (sbt-1 maintenance branch) and users on
sbt 2.x pick up `1.x.y` (main).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@github-actions github-actions Bot added the doc label Jun 16, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md to document the compatibility of sbt-pack with sbt 2.x (Scala 3) and sbt 1.x (Scala 2.12), including a version mapping table. Feedback points out that using wildcard versions like "1.x.y" and "0.23.x" in the sbt plugin configuration snippet will cause dependency resolution errors, and suggests replacing them with concrete, copy-pasteable versions.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
Comment on lines +37 to +41
// For sbt 2.x (Scala 3)
addSbtPlugin("org.xerial.sbt" % "sbt-pack" % "1.x.y")

// For sbt 1.x (Scala 2.12)
addSbtPlugin("org.xerial.sbt" % "sbt-pack" % "0.23.x")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Using literal "1.x.y" and "0.23.x" in the addSbtPlugin configuration will cause dependency resolution errors in sbt, as Ivy/sbt does not support .x wildcards in version strings. It is better to use concrete versions (like "1.0.0" and "0.23.0") so that the snippet is directly copy-pasteable and valid.

Suggested change
// For sbt 2.x (Scala 3)
addSbtPlugin("org.xerial.sbt" % "sbt-pack" % "1.x.y")
// For sbt 1.x (Scala 2.12)
addSbtPlugin("org.xerial.sbt" % "sbt-pack" % "0.23.x")
// For sbt 2.x (Scala 3)
addSbtPlugin("org.xerial.sbt" % "sbt-pack" % "1.0.0")
// For sbt 1.x (Scala 2.12)
addSbtPlugin("org.xerial.sbt" % "sbt-pack" % "0.23.0")

@xerial xerial merged commit 638aed2 into main Jun 16, 2026
4 checks passed
@xerial xerial deleted the readme-and-version-bump branch June 16, 2026 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant