summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Gerace <nickagerace@gmail.com>2022-03-25 17:40:06 -0400
committerNick Gerace <nickagerace@gmail.com>2022-04-16 18:31:15 -0400
commit468e71e137833d589baa0a651599feb4258f1e84 (patch)
tree448b3b7710e6959bbd822ec0b9904c0c01eabfb3 /docs
parentdf24f0d80db4ef3b4757d6a3fea6be344eae45fc (diff)
downloadgfold-468e71e137833d589baa0a651599feb4258f1e84.zip
Fix origin remote and config file lookup errors
- Fix error when remote is not "origin" and fallback to alternate remotes if "origin" is not found - Add failure scenario to core integration test - Fix error where "gfold.toml" not existing would result in execution failure - Add config file lookup behavior to README - Remove debug flag in favor of RUST_LOG - This also results in the logging module being removed since setting the logging should be configured via RUST_LOG - Add RUST_LOG and RUST_BACKTRACE to README and CLI help troubleshooting sections - Update display flags in README to use `-d` - Update flag description for color to use "never" instead of "off" as one of its options - Add sequencing debug logs (e.g. "foo has completed") - Switch back to anyhow for its backtrace feature - Update to 4.0.0-rc.2 Signed-off-by: Nick Gerace <nickagerace@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/DEVELOPING.md4
-rw-r--r--docs/RELEASE.md2
2 files changed, 3 insertions, 3 deletions
diff --git a/docs/DEVELOPING.md b/docs/DEVELOPING.md
index d990684..23b6607 100644
--- a/docs/DEVELOPING.md
+++ b/docs/DEVELOPING.md
@@ -18,9 +18,9 @@ Now, ensure that lints, tests, and builds succeed.
```shell
cargo fmt --all -- --check
cargo clippy -- -D warnings
-cargo doc
+cargo doc --all
cargo test
-cargo build
+cargo build --all-targets
```
> Alternatively, you can replace `cargo test` above with [cargo nextest](https://github.com/nextest-rs/nextest).
diff --git a/docs/RELEASE.md b/docs/RELEASE.md
index 3c0f43e..7d177c5 100644
--- a/docs/RELEASE.md
+++ b/docs/RELEASE.md
@@ -23,7 +23,7 @@ cargo build
- [ ] Create and _do not merge_ a commit with the following message: `Update to <tag>`
- [ ] Test and verify the publishing workflow:
-```bash
+```shell
cargo publish --dry-run
```