Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 2.25 KB

VERSIONING.md

File metadata and controls

61 lines (44 loc) · 2.25 KB
Raw

Versioning

This page describes how we version Scala.js core. Notably what compatibility guarantees we give with respect to the version numbering.

Major Changes

The following changes must cause a major version bump.

  • Backward incompatible change in the IR
  • Backward binary incompatible change in the standard library
  • Backward incompatible change in the contract for calling JDK APIs

Severe Changes

Severe changes can break the ecosystem of sbt plugins and other build tools, but not the ecosystem of libraries (which would be major). Severe changes should be done only if absolutely necessary. The following are considered severe changes:

  • Backward binary incompatible changes in linker.* or linker.interface.*
  • Backward binary incompatible changes in sbtplugin.*
  • Backward binary incompatible changes in testadapter.*

Severe changes are difficult from a versioning point of view, since they require a careful tradeoff:

  • if a major bump is made, it forces libraries to re-publish unnecessarily (because the IR is not actually affected).
  • if no major bump is made, the tooling API versioning breaks the SemVer contract.

As such, we leave the best course of action in case of severe changes to the maintainers. Possible courses of action are:

  • Major version bump
  • Minor version bump
  • Separating versioning of IR and tooling.

Minor Changes

The following changes must cause a minor version bump.

  • Forward incompatible change in the IR
  • Backward source incompatible change at the language level or at the standard library level (including any addition of public API in the stdlib)
  • Backward source incompatible change in linker.*, linker.interface.* or sbtplugin.* (including any addition of public API)
  • Backward source incompatible changes in testadapter.*
  • Backward binary incompatible changes in ir.*, linker.interface.unstable.* or linker.standard.*

Patch Changes

All other changes cause a patch version bump only. Explicitly (but not exhaustively):

  • Backward source incompatible change in ir.*, linker.interface.unstable.* or linker.standard.*
  • Backward source/binary incompatible changes elsewhere in linker.**
  • Fixes or additions in the JDK libs (since they are always backward source and binary compatible)