search

palantir / gradle-consistent-versions

Compact, constraint-friendly lockfiles for your dependencies
Apache License 2.0
112 stars 15 forks source link

More specific command in versions.lock header comment #1122

Closed ash211 closed 7 months ago

ash211 commented 7 months ago

Builds on https://github.com/palantir/gradle-consistent-versions/pull/723 which added the writeVersionsLock command

Before this PR

Users (like me) will run ./gradlew --write-locks to update the versions.lock file for merge conflicts (as directed by the header comment) and end up doing much more work than needed. On one internal repo I have, it's a 30s vs 5m30s difference!

After this PR

==COMMIT_MSG== More specific command in versions.lock header comment ==COMMIT_MSG==

The old --write-locks syntax still works, it is just not advertised in the file's header comment.

Possible downsides?

The --write-locks syntax is now de-emphasized, and users wanting to update all their lock files in one command may have trouble discovering it.

changelog-app[bot] commented 7 months ago

Generate changelog in changelog-dir>`changelog/@unreleased`</changelog-dir

What do the change types mean? - `feature`: A new feature of the service. - `improvement`: An incremental improvement in the functionality or operation of the service. - `fix`: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way. - `break`: Has the potential to break consumers of this service's API, inclusive of both Palantir services and external consumers of the service's API (e.g. customer-written software or integrations). - `deprecation`: Advertises the intention to remove service functionality without any change to the operation of the service itself. - `manualTask`: Requires the possibility of manual intervention (running a script, eyeballing configuration, performing database surgery, ...) at the time of upgrade for it to succeed. - `migration`: A fully automatic upgrade migration task with no engineer input required. _Note: only one type should be chosen._
How are new versions calculated? - ❗The `break` and `manual task` changelog types will result in a major release! - 🐛 The `fix` changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease. - ✨ All others will result in a minor version release.

Type

- [ ] Feature - [x] Improvement - [ ] Fix - [ ] Break - [ ] Deprecation - [ ] Manual task - [ ] Migration

Description

More specific command in versions.lock header comment **Check the box to generate changelog(s)** - [x] Generate changelog entry
svc-autorelease commented 7 months ago

Released 2.20.0