Skip to content

Commit

Permalink
Proposal for v2 lockfile format (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
stringbean authored Jul 6, 2024
1 parent c9784a7 commit 6a8a564
Show file tree
Hide file tree
Showing 6 changed files with 546 additions and 10 deletions.
11 changes: 6 additions & 5 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ organizationName := "Michael Stringer"
startYear := Some(2019)
licenses += ("Apache-2.0", url("https://www.apache.org/licenses/LICENSE-2.0.txt"))

scriptedLaunchOpts := {
scriptedLaunchOpts := {
scriptedLaunchOpts.value ++
Seq("-Xmx1024M", "-Dplugin.version=" + version.value)
}
Expand All @@ -31,13 +31,14 @@ developers := List(
Developer("stringbean", "Michael Stringer", "@the_stringbean", url("/~https://github.com/stringbean")),
)

homepage := Some(url("/~https://github.com/stringbean/sbt-dependency-lock"))
scmInfo := Some(
homepage := Some(url("/~https://github.com/stringbean/sbt-dependency-lock"))
scmInfo := Some(
ScmInfo(
url("/~https://github.com/stringbean/sbt-dependency-lock"),
"/~https://github.com/stringbean/sbt-dependency-lock.git"))
git.remoteRepo := "git@github.com:stringbean/sbt-dependency-lock.git"
publishTo := sonatypePublishToBundle.value
git.remoteRepo := "git@github.com:stringbean/sbt-dependency-lock.git"
paradoxNavigationDepth := 3
publishTo := sonatypePublishToBundle.value

import sbtrelease.ReleasePlugin.autoImport.ReleaseTransformations.*

Expand Down
9 changes: 6 additions & 3 deletions src/main/paradox/file-formats/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ _sbt-dependency-lock_ stores lockfile information in JSON format with a version
top-level object. Details of the file format can be found on these pages, and we encourage other tools to utilise the
output information.

| Version | Added In | Removed In | Description |
| ---------------------: | -------: | ---------: | ---------------- |
| @ref:[1](version-1.md) | 0.1.0 | _current_ | Initial version. |
| Version | Added In | Removed In | Description |
| ---------------------: | ---------: | ---------: | ------------------------- |
| @ref:[1](version-1.md) | 0.1.0 | _current_ | Initial version. |
| @ref:[2](version-2.md) | _proposed_ | _N/A_ | Proposed enhanced format. |


Current default version is: 1

@@@ index
* [Version 1](version-1.md)
* [Version 2](version-2.md)
@@@
5 changes: 3 additions & 2 deletions src/main/paradox/file-formats/version-1.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Version 1
# Version 1 (current)

* **Added in:** 0.1.0
* **Removed in:** _N/A_
* **Schema:** [lockfile-v1.schema.json](../lockfile-v1.schema.json)

## Types

Expand All @@ -13,7 +14,7 @@ dependencies.
#### lockVersion

* **Type:** Integer.
* **Description:** Version of the lockfile - always 1.
* **Description:** Version of the lockfile: `1`.

#### timestamp

Expand Down
Loading

0 comments on commit 6a8a564

Please sign in to comment.