diff options
author | Tim Oram <dev@mitmaro.ca> | 2022-04-15 11:33:01 -0230 |
---|---|---|
committer | Tim Oram <dev@mitmaro.ca> | 2022-04-15 11:59:53 -0230 |
commit | 7de16ec66ac365b86ca5ae454d257cb61676b915 (patch) | |
tree | 5fd70aad85266facccfde06afa89f326a93cc2e4 | |
parent | 991f499e23cdf78095c5c81382a3e97420a868e2 (diff) |
Relax semver requirements for semver
Trying to keep semver requirements for the sub-crates of the project is
burdensome, and the crates are not meant to be used separately. This
adds a README to each sub-crate that defines this breaking of semver.
-rw-r--r-- | src/config/CHANGELOG.md | 29 | ||||
-rw-r--r-- | src/config/Cargo.toml | 2 | ||||
-rw-r--r-- | src/config/README.md | 3 | ||||
-rw-r--r-- | src/config/migration-guide.md | 17 | ||||
-rw-r--r-- | src/core/Cargo.toml | 2 | ||||
-rw-r--r-- | src/core/README.md | 3 | ||||
-rw-r--r-- | src/display/Cargo.toml | 2 | ||||
-rw-r--r-- | src/display/README.md | 3 | ||||
-rw-r--r-- | src/git/Cargo.toml | 2 | ||||
-rw-r--r-- | src/git/README.md | 3 | ||||
-rw-r--r-- | src/input/Cargo.toml | 2 | ||||
-rw-r--r-- | src/input/README.md | 3 | ||||
-rw-r--r-- | src/todo_file/Cargo.toml | 2 | ||||
-rw-r--r-- | src/todo_file/README.md | 3 | ||||
-rw-r--r-- | src/view/CHANGELOG.md | 19 | ||||
-rw-r--r-- | src/view/Cargo.toml | 2 | ||||
-rw-r--r-- | src/view/README.md | 3 |
17 files changed, 28 insertions, 72 deletions
diff --git a/src/config/CHANGELOG.md b/src/config/CHANGELOG.md deleted file mode 100644 index e202370..0000000 --- a/src/config/CHANGELOG.md +++ /dev/null @@ -1,29 +0,0 @@ -# Change Log -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). - -See the [migration guide](migration-guide.md) for migrating between major versions. - -## 2.0.0 - Unreleased - -### Added - -- Implemented `TryFrom<&Repository>` for `Config` -- Implemented `TryFrom<&Config>` for `Config`, `GitConfig`, `KeyBindings`, and `Theme` -- Implemented `Default` for `Config`, `GitConfig`, `KeyBindings`, and `Theme` - -### Changed - -- Now only accepts `girt-git` structs instead of direct `git2-rs` structs -- `GitConfig::new` no longer takes a config reference, and now returns a default instance - -### Removed - -- `create_config` test utility -- `create_theme` test utility - -## 1.0.0 - 2021-07-05 - -### Added -- Initial release diff --git a/src/config/Cargo.toml b/src/config/Cargo.toml index 3a237e0..28fc5ee 100644 --- a/src/config/Cargo.toml +++ b/src/config/Cargo.toml @@ -9,7 +9,7 @@ repository = "https://github.com/MitMaro/git-interactive-rebase-tool" edition = "2021" keywords = ["git", "config"] categories = ["command-line-interface", "command-line-utilities", "config"] -readme = "../../README.md" +readme = "README.md" [lib] name = "config" diff --git a/src/config/README.md b/src/config/README.md new file mode 100644 index 0000000..35b03f9 --- /dev/null +++ b/src/config/README.md @@ -0,0 +1,3 @@ +# GIRT Config Crate + +This crate is part of the larger [Git Interactive Rebase Tool](../../README.md). The version is pinned to the root project, and this crate does not follow SemVer. diff --git a/src/config/migration-guide.md b/src/config/migration-guide.md deleted file mode 100644 index a8dbd78..0000000 --- a/src/config/migration-guide.md +++ /dev/null @@ -1,17 +0,0 @@ -# Migration Guide - -## 1.x.x to 2.0.0 -- `Config::new()` no longer automatically loads configuration from the repository. Instead, use `Config::try_from` providing a `git::Repository` instance. - -```rust -use git::Repository; -use config::Config; - -fn main() { - let config = Config::try_from(&Repository::open_from_env().unwrap()); -} -``` - -* `Config::new()` now returns a default instance that is almost identical to the `create_config` test utility, and is a drop in replacement in most cases. - -* `Theme::new()` returns a default instance that is almost identical to the `create_theme` test utility, and is a drop in replacement in most cases.
\ No newline at end of file diff --git a/src/core/Cargo.toml b/src/core/Cargo.toml index 459fdc6..df13645 100644 --- a/src/core/Cargo.toml +++ b/src/core/Cargo.toml @@ -9,7 +9,7 @@ repository = "https://github.com/MitMaro/git-interactive-rebase-tool" edition = "2021" keywords = ["git", "cli"] categories = ["command-line-interface", "command-line-utilities", "text-editors"] -readme = "../../README.md" +readme = "README.md" [lib] name = "core" diff --git a/src/core/README.md b/src/core/README.md new file mode 100644 index 0000000..53a2f72 --- /dev/null +++ b/src/core/README.md @@ -0,0 +1,3 @@ +# GIRT Core Crate + +This crate is part of the larger [Git Interactive Rebase Tool](../../README.md). The version is pinned to the root project, and this crate does not follow SemVer. diff --git a/src/display/Cargo.toml b/src/display/Cargo.toml index a4eb51c..d5d9360 100644 --- a/src/display/Cargo.toml +++ b/src/display/Cargo.toml @@ -9,7 +9,7 @@ repository = "https://github.com/MitMaro/git-interactive-rebase-tool" edition = "2021" keywords = ["git", "cli"] categories = ["command-line-interface", "command-line-utilities"] -readme = "../../README.md" +readme = "README.md" [lib] name = "display" diff --git a/src/display/README.md b/src/display/README.md new file mode 100644 index 0000000..40b4f2d --- /dev/null +++ b/src/display/README.md @@ -0,0 +1,3 @@ +# GIRT Display Crate + +This crate is part of the larger [Git Interactive Rebase Tool](../../README.md). The version is pinned to the root project, and this crate does not follow SemVer. diff --git a/src/git/Cargo.toml b/src/git/Cargo.toml index 09e8b3e..31b250d 100644 --- a/src/git/Cargo.toml +++ b/src/git/Cargo.toml @@ -9,7 +9,7 @@ repository = "https://github.com/MitMaro/git-interactive-rebase-tool" edition = "2021" keywords = ["git"] categories = ["command-line-interface", "command-line-utilities"] -readme = "../../README.md" +readme = "README.md" [lib] name = "git" diff --git a/src/git/README.md b/src/git/README.md new file mode 100644 index 0000000..0fc2655 --- /dev/null +++ b/src/git/README.md @@ -0,0 +1,3 @@ +# GIRT Git Crate + +This crate is part of the larger [Git Interactive Rebase Tool](../../README.md). The version is pinned to the root project, and this crate does not follow SemVer. diff --git a/src/input/Cargo.toml b/src/input/Cargo.toml index 78d363a..4c7b71e 100644 --- a/src/input/Cargo.toml +++ b/src/input/Cargo.toml @@ -9,7 +9,7 @@ repository = "https://github.com/MitMaro/git-interactive-rebase-tool" edition = "2021" keywords = ["git", "input"] categories = ["command-line-interface", "command-line-utilities"] -readme = "../../README.md" +readme = "README.md" [lib] name = "input" diff --git a/src/input/README.md b/src/input/README.md new file mode 100644 index 0000000..a2d4305 --- /dev/null +++ b/src/input/README.md @@ -0,0 +1,3 @@ +# GIRT Input Crate + +This crate is part of the larger [Git Interactive Rebase Tool](../../README.md). The version is pinned to the root project, and this crate does not follow SemVer. diff --git a/src/todo_file/Cargo.toml b/src/todo_file/Cargo.toml index 9edafbe..a77790e 100644 --- a/src/todo_file/Cargo.toml +++ b/src/todo_file/Cargo.toml @@ -9,7 +9,7 @@ repository = "https://github.com/MitMaro/git-interactive-rebase-tool" edition = "2021" keywords = ["git"] categories = ["command-line-interface", "command-line-utilities"] -readme = "../../README.md" +readme = "README.md" [lib] name = "todo_file" diff --git a/src/todo_file/README.md b/src/todo_file/README.md new file mode 100644 index 0000000..77c92e7 --- /dev/null +++ b/src/todo_file/README.md @@ -0,0 +1,3 @@ +# GIRT TodoFile Crate + +This crate is part of the larger [Git Interactive Rebase Tool](../../README.md). The version is pinned to the root project, and this crate does not follow SemVer. diff --git a/src/view/CHANGELOG.md b/src/view/CHANGELOG.md deleted file mode 100644 index 5f7d625..0000000 --- a/src/view/CHANGELOG.md +++ /dev/null @@ -1,19 +0,0 @@ -# Change Log -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). - -See the [migration guide](migration-guide.md) for migrating between major versions. - -## 1.1.0 - Unreleased - -### Added - -- New `push_lines` method to `ViewDataUpdater` to push a multiline `&str` -- Support for `AnyLine`, `StartsWith` and `EndsWith` on `assert_rendered_output` macro -- Support for options for the `assert_rendered_output` macro - -## 1.0.0 - 2021-07-05 - -### Added -- Initial release diff --git a/src/view/Cargo.toml b/src/view/Cargo.toml index 42b1f03..86e96ca 100644 --- a/src/view/Cargo.toml +++ b/src/view/Cargo.toml @@ -9,7 +9,7 @@ repository = "https://github.com/MitMaro/git-interactive-rebase-tool" edition = "2021" keywords = ["git", "view"] categories = ["command-line-interface", "command-line-utilities", "text-editors"] -readme = "../../README.md" +readme = "README.md" [lib] name = "view" diff --git a/src/view/README.md b/src/view/README.md new file mode 100644 index 0000000..69463ea --- /dev/null +++ b/src/view/README.md @@ -0,0 +1,3 @@ +# GIRT View Crate + +This crate is part of the larger [Git Interactive Rebase Tool](../../README.md). The version is pinned to the root project, and this crate does not follow SemVer. |