ChainSafe / ChainSafe/forest

ban `std::env::var`, and have one `ForestVars` structure

Open
#4,182 0 comments 0 reactions 0 assignees View on GitHub
Priority: 4 - Low
Dominant language
Rust
Stars
697
Forks
200
Avg merge
1d 5h
Merged PRs (30d)
65

Description

- We should have one struct where forest environment variables are described (for end users) and accessed (in code)
- Remove `documentation/src/environment_variables.md`, and have it link to the rustdoc for the above

These means we have:
- better control over environment variables
- documentation that stays up-to-date

We could also have an approach like #3370 or using https://docs.rs/figment/latest/figment/index.html for config

Cargo did something similar last year: https://github.com/rust-lang/cargo/issues/11588

_Originally posted by @aatifsyed in https://github.com/ChainSafe/forest/pull/4177#discussion_r1560771473_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.