Update changelog and readme

This commit is contained in:
Ivan Petkov 2022-02-11 20:33:11 -08:00
parent c4ca8704b9
commit 47d47ef5b5
No known key found for this signature in database
GPG Key ID: BB6F9EFC065832B6
2 changed files with 26 additions and 1 deletions

View File

@ -4,6 +4,27 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## [0.3.0] - 2022-02-11
### Added
* `downloadCargoPackageFromGit` has been added to handle downloading and
unpacking a cargo workspace from a git repository
* `vendorCargoRegistries` has been added to handle vendoring crates from all
registries used in a `Cargo.lock` file
* `vendorGitDeps` has been added to handle vendoring crates from all git sources
used in a `Cargo.lock` file
### Changed
* `vendorCargoDeps` now automatically handles git dependencies by default
- Git dependencies will be vendored as another source in the output derivation
- The cargo configuration is done such that the sources are available to use
when it decides, without overriding that crate for the entire workspace
* For example, if your workspace contains a crate only used for testing
which has a git dependency of a crate used by other parts of the
workspace, then only that crate will use the git dependency. The rest of
the workspace will continue to use the crates.io version, just like cargo
behaves when used outside of Nix.
## [0.2.1] - 2022-02-11
### Changed
* `cargoFmt` will install cargo artifacts by default (or install an empty
@ -37,5 +58,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
## 0.1.0 - 2022-01-22
- First release
[0.3.0]: https://github.com/ipetkov/crane/compare/v0.2.1...v0.3.0
[0.2.1]: https://github.com/ipetkov/crane/compare/v0.2.0...v0.2.1
[0.2.0]: https://github.com/ipetkov/crane/compare/v0.1.0...v0.2.0

View File

@ -15,7 +15,10 @@ at a glance, the following are supported:
* Automatic vendoring of dependencies in a way that works with Nix
- Alternative cargo registries are supported (with a minor configuration
change)
- Git dependency support coming soon!
- Git dependencies are automatically supported without additional
configuration.
- Cargo retains the flexibility to only use these dependencies when they are
actually needed, without forcing an override for the entire workspace.
* Reusing dependency artifacts after only building them once
* [clippy](https://github.com/rust-lang/rust-clippy) checks
* [rustfmt](https://github.com/rust-lang/rustfmt) checks