summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Gerace <nickagerace@gmail.com>2022-12-21 16:37:23 -0500
committerNick Gerace <nickagerace@gmail.com>2022-12-21 16:37:23 -0500
commit687b3f50d359c4225a5b4e4085c43d693e8a12d4 (patch)
tree7ee8ceedfe02eee45fa384274fde9e2694ae0a12
parente0ce979dbd8a2e343a105ac874873697a2100257 (diff)
downloadgfold-687b3f50d359c4225a5b4e4085c43d693e8a12d4.zip
Update to 4.2.0
- Update to 4.2.0 - Add upstream libgit2 issue to README - Add locked flag to README installation section Signed-off-by: Nick Gerace <nickagerace@gmail.com>
-rw-r--r--CHANGELOG.md8
-rw-r--r--Cargo.lock2
-rw-r--r--README.md35
-rw-r--r--crates/gfold/Cargo.toml2
4 files changed, 37 insertions, 10 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a49b608..8d686a3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,14 +8,16 @@ For new changes prior to version 4.0.0, please see [CHANGELOG_PRE_V4](./docs/CHA
## Unreleased
-<!-- The latest version contains all changes. -->
+The latest version contains all changes.
+
+## 4.2.0 - 2022-12-21
### Changed
-- Add "unknown" status for repositories hitting the "extensions.worktreeconfig" error
+- Add "unknown" status for repositories hitting the `extensions.worktreeconfig` error
- Bump dependencies
- Change "unpushed" color to blue
-- Ignore the "extensions.worktreeconfig" error until the corresponding upstream issue is resolved: https://github.com/libgit2/libgit2/issues/6044
+- Ignore the `extensions.worktreeconfig` error until the corresponding upstream issue is resolved: https://github.com/libgit2/libgit2/issues/6044
## 4.1.2 - 2022-12-20
diff --git a/Cargo.lock b/Cargo.lock
index 24f9b8f..644c37f 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -259,7 +259,7 @@ dependencies = [
[[package]]
name = "gfold"
-version = "4.1.2"
+version = "4.2.0"
dependencies = [
"anyhow",
"clap",
diff --git a/README.md b/README.md
index b6e8e8f..86195f3 100644
--- a/README.md
+++ b/README.md
@@ -168,6 +168,12 @@ You can use [cargo](https://crates.io) to install the [crate](https://crates.io/
cargo install gfold
```
+Use the `--locked` flag if you'd like Cargo to use `Cargo.lock`.
+
+```shell
+cargo install --locked gfold
+```
+
Keeping the crate up to date is easy with [cargo-update](https://crates.io/crates/cargo-update).
```shell
@@ -193,12 +199,24 @@ Please [file an issue](https://github.com/nickgerace/gfold/issues/new)!
`gfold` is intended to be ran on *any* tier one Rust 🦀 target.
Please [file an issue](https://github.com/nickgerace/gfold/issues) if your platform is unsupported.
-## Troubleshooting
+## Troubleshooting and Known Issues
-If you encounter unexpected behavior or a bug, please [file an issue](https://github.com/nickgerace/gfold/issues) and debug
-locally with `RUST_BACKTRACE=1 RUST_LOG=debug` prepended when executing `gfold`.
-You can also adjust each variable, as needed, to aid investigation.
-Please attach relevant logs from execution with sensitive bits redacted in order to help resolve your issue.
+If you encounter unexpected behavior or a bug and would like to see more details, please run `gfold` with the following
+environment variables:
+
+```shell
+# You may also want to add relevant arg(s) and flag(s).
+RUST_BACKTRACE=1 RUST_LOG=debug gfold
+```
+
+If the issue persists, please [file an issue](https://github.com/nickgerace/gfold/issues).
+
+### Tuning Environment Variables
+
+Since [`RUST_BACKTRACE`](https://doc.rust-lang.org/std/backtrace/index.html) and
+[`RUST_LOG`](https://docs.rs/env_logger/latest/env_logger/), do not have `gfold`-specific behaviors, you can adjust
+them just as you would in other projects to aid investigation.
+Please attach relevant logs from execution with _sensitive bits redacted_ in order to help resolve your issue.
### Coreutils Collision on macOS
@@ -210,6 +228,13 @@ Here is an example with the `o` dropped from `gfold`:
alias gfld=$HOME/.cargo/bin/gfold
```
+### Upstream `libgit2` Issue
+
+If you are seeing `unsupported extension name extensions.worktreeconfig` or similar errors, it may be related to
+[libgit2/libgit2#6044](https://github.com/libgit2/libgit2/issues/6044).
+
+This repository's tracking issue is [#205](https://github.com/nickgerace/gfold/issues/205).
+
## Community
For more information and thanks to contributors, users, and the "community" at large, please refer to the **[THANKS](./docs/THANKS.md)** file.
diff --git a/crates/gfold/Cargo.toml b/crates/gfold/Cargo.toml
index e8418c9..cfd21b6 100644
--- a/crates/gfold/Cargo.toml
+++ b/crates/gfold/Cargo.toml
@@ -10,7 +10,7 @@ readme = "../../README.md"
repository = "https://github.com/nickgerace/gfold/"
edition = "2021"
-version = "4.1.2"
+version = "4.2.0"
[dependencies]
anyhow = { version = "1.0", features = ["backtrace"] }