Skip to content

Commit b43dcfc

Browse files
committed
Documentation tweaks (#24)
* Remove v1 format warning * Add a section on alternatives * Tweak badges
1 parent 8fdabb6 commit b43dcfc

File tree

4 files changed

+22
-8
lines changed

4 files changed

+22
-8
lines changed

.github/workflows/ci.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
name: ci
2+
13
on:
24
push:
35
branches:

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Build Status](https://img.shields.io/github/workflow/status/stringbean/sbt-dependency-lock/ci)](https://github.com/stringbean/sbt-dependency-lock/actions/workflows/ci.yml)
44
[![Codacy grade](https://img.shields.io/codacy/grade/d45ca406c90c45c88a3a317563bc3302?label=codacy)](https://codacy.com/app/stringbean/sbt-dependency-lock)
55
[![Known Vulnerabilities](https://snyk.io/test/github/stringbean/sbt-dependency-lock/badge.svg?targetFile=build.sbt)](https://snyk.io/test/github/stringbean/sbt-dependency-lock?targetFile=build.sbt)
6-
![Maven Central](https://img.shields.io/maven-central/v/software.purpledragon/sbt-dependency-lock_2.12_1.0?label=sbt%201.x)
6+
![Maven Central](https://maven-badges.herokuapp.com/maven-central/software.purpledragon/sbt-dependency-lock/badge.svg?style=flat)
77
[![GitHub Discussions](https://img.shields.io/github/discussions/stringbean/sbt-dependency-lock)](https://github.com/stringbean/sbt-dependency-lock/discussions)
88

99
An sbt plugin to create a dependency lockfile similar to `package-lock.json` for npm or `Gemfile.lock` for RubyGems.
@@ -35,4 +35,4 @@ A mismatch between the lockfile and current dependencies will generate an error
3535
[error] org.scalatest:scalatest_2.12:[3.0.8]->[3.0.7] (test)
3636
```
3737

38-
See the [docs](https://stringbean.github.io/sbt-dependency-lock) for further information on how the plugin works.
38+
See the [docs](https://stringbean.github.io/sbt-dependency-lock) for further information on how the plugin works.

src/main/paradox/file-formats/version-1.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
11
# Version 1
22

3-
@@@warning
4-
This version of the lockfile has not been finalised and may change as features are added or bugs resolved.
5-
6-
The format will be finalised in version 1.0.0.
7-
@@@
8-
93
* **Added in:** 0.1.0
104
* **Removed in:** _N/A_
115

src/main/paradox/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,24 @@ cause a snowball effect of dozens of updated transitive dependencies.
1111
This plugin generates a lockfile based on the current project dependencies that can be checked into source control and
1212
can be checked to see what dependencies have changed.
1313

14+
## Alternatives
15+
16+
### sbt-lock
17+
18+
[sbt-lock](https://github.com/tkawachi/sbt-lock) is an sbt plugin that generates lockfiles to control the resolved
19+
dependency versions. When enabled it will generate a `lock.sbt` file that sets `Compile / dependencyOverrides` to the
20+
currently resolved versions, any further changes to the dependencies will be overridden until the lockfile is
21+
regenerated.
22+
23+
While `sbt-lock` is good at fixing the versions that sbt will use for future builds it is weak at showing what
24+
dependencies have changed. Until the lockfile is 'unlocked' any dependency changes you make to `build.sbt` will be
25+
ignored; this forces you to 'unlock', update the dependencies, 'lock' again and then diff the lockfile to see what has
26+
changed.
27+
28+
The approach taken by `sbt-dependency-lock` is to allow changes to be made to the dependencies, warn you that the
29+
dependencies have changed and generate a report showing the changes. Keeping the lockfile up to date can be enforced
30+
using a lockfile check in a CI pipeline.
31+
1432
@@@ index
1533
* [Getting Started](getting-started.md)
1634
* [Settings](settings.md)

0 commit comments

Comments
 (0)