Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal for v2 lockfile format #42

Merged
merged 4 commits into from
Jul 6, 2024
Merged

Proposal for v2 lockfile format #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8177b78
WIP proposal for lockfile v2
stringbean Jul 4, 2021
e6b14b8
Add JSON schemas
stringbean Jul 4, 2024
0ad3bd1
More tweaks to v2 docs
stringbean Jul 6, 2024
457cfe2
Make it clearer in nav that v2 is a proposal
stringbean Jul 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions build.sbt
View file
Open in desktop
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 := "[email protected]:stringbean/sbt-dependency-lock.git"
publishTo := sonatypePublishToBundle.value
git.remoteRepo := "[email protected]: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
View file
Open in desktop
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
View file
Open in desktop
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
Loading