Skip to content

Commit

Permalink
repository(doc): improved changelog…
Browse files Browse the repository at this point in the history
…akin to 'Keep a changelog'.
  • Loading branch information
Byron committed Sep 14, 2021
1 parent cdf4199 commit 8b82f7d
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions git-repository/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
### v0.10.0 (2021-??-??)
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

### Breaking

- Change return value of `prelude::RepositoryAccessExt::committer()` from `git_actor::Signature` to `Result<git_actor::Signature, easy::borrow:repo::Error>`
- Change return value of `prelude::ReferenceAccessExt` from `Result<Vec<RefEdit>>, _>` to `Result<easy::Reference, _>`.
- Rename `State` structs that serve as platform for iterators or other dependent types into `Platform`. These are usually intermediate objects only.
- Rename `easy::Reference::log()` into `easy::Reference::logs()`

### v0.9.1 (2021-09-10)
## v0.9.1 (2021-09-10)

- Remove `max-performance` feature from default set until the `msvc` build issue is fixed. Otherwise it will surprisingly break windows builds.

### v0.9.0 (2021-09-08)
## v0.9.0 (2021-09-08)

- rename `prelude::ConfigAccessExt` to `prelude::RepositoryAccessExt`
- `prelude::ObjectAccessExt::commit()` signature change
- cargo feature changed in incompatible ways. `network` was replaced by more finegrained options for _blocking_ and _async_ networking, as well as optional http transport
-
#### New
### New

- `init()`
- `init_bare()`
Expand All @@ -26,16 +35,16 @@
- `easy::ext::ReferenceAccessExt::head()`
- `ext::ReferenceExt` trait

#### Breaking
### Breaking
- **renames / moves / Signature Changes**
- `path::Path` to `Path`
- `init::repository(dir)` -> `path::create::into(dir, **Kind**)`

### v0.8.1 (2021-08-28)
## v0.8.1 (2021-08-28)

- Introduce `EasyArcExclusive` type, now available thanks to `parking_lot` 0.11.2

### v0.8.0 (2021-08-27)
## v0.8.0 (2021-08-27)

- Rename `object` to `objs` to be equivalent to `refs` and make space for the new `object` module
- various minor version updates of pre-release dependencies

0 comments on commit 8b82f7d

Please sign in to comment.