Skip to content

Commit

Permalink
docs: replace references to lib with craneLib (#274)
Browse files Browse the repository at this point in the history
* `lib` is already a common import representing `pkgs.lib`
* Consistently using `craneLib` in the docs and examples will ensure
  better clarity
  • Loading branch information
ipetkov authored Mar 20, 2023
1 parent 6fd78bc commit 141943d
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 70 deletions.
24 changes: 15 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,34 @@ files parsed as nix attribute sets.
replacement of) `builtins.path` to ensure reproducible results whenever paths
like `./.` or `./..` are used directly.

### Changed
* **Breaking** (technically): `mkCargoDerivation` will remove the following
attributes before lowering to `mkDerivation`: `cargoLock`, `cargoLockContents`
and `cargoLockParsed`. If your derivation needs these values to be present
they can be explicitly passed through via `.overrideAttrs`
`buildDepsOnly` as `dummySrc` will take priority
* The API docs have been updated to refer to `craneLib` (instead of just `lib`)
to avoid ambiguities with `pkgs.lib`.
* cargo is now invoked with `--release` when `$CARGO_PROFILE == release` instead
of passing in `--profile release` to better support tools which do not
understand the latter

### Fixed
* Fixed support for projects depending on crates utilising per-target workspace dependencies.

## [0.11.3] - 2023-02-19

### Fixed
* Fixed an unintentional cache invalidation whenever `buildDepsOnly` would run
on an unfiltered source (like `src = ./.;`).
* Fixed support for projects depending on crates utilising per-target workspace dependencies.

### Changed
* **Breaking** (technically): `mkCargoDerivation` will remove the following
attributes before lowering to `mkDerivation`: `cargoLock`, `cargoLockContents`
and `cargoLockParsed`. If your derivation needs these values to be present
they can be explicitly passed through via `.overrideAttrs`
`buildDepsOnly` as `dummySrc` will take priority
* A warning will now be emitted if a derivation's `pname` or `version`
attributes are not set and the value cannot be loaded from the derivation's
root `Cargo.toml`. To resolve it consider setting `pname = "...";` or `version
= "...";` explicitly on the derivation.
* A warning will now be emitted if `src` and `dummySrc` are passed to
`buildDepsOnly` as `dummySrc` will take priority
* cargo is now invoked with `--release` when `$CARGO_PROFILE == release` instead
of passing in `--profile release` to better support tools which do not
understand the latter

## [0.11.2] - 2023-02-11

Expand Down
Loading

0 comments on commit 141943d

Please sign in to comment.