Skip to content

chore: update env variables#6705

Merged
LesnyRumcajs merged 2 commits intomainfrom
env-var-update
Mar 9, 2026
Merged

chore: update env variables#6705
LesnyRumcajs merged 2 commits intomainfrom
env-var-update

Conversation

@LesnyRumcajs
Copy link
Member

@LesnyRumcajs LesnyRumcajs commented Mar 9, 2026

Summary of changes

Changes introduced in this pull request:

  • added some missing vars from env reference

Reference issue to close (if applicable)

Closes

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Outside contributions

  • I have read and agree to the CONTRIBUTING document.
  • I have read and agree to the AI Policy document. I understand that failure to comply with the guidelines will lead to rejection of the pull request.

Summary by CodeRabbit

  • Documentation
    • Expanded environment variable reference with four new configuration options. Each entry now includes type, default value, example usage, and a clear description to help administrators and operators configure runtime behavior and caching settings more effectively.

@LesnyRumcajs LesnyRumcajs requested a review from a team as a code owner March 9, 2026 10:01
@LesnyRumcajs LesnyRumcajs requested review from akaladarshi and hanabi1224 and removed request for a team March 9, 2026 10:01
@LesnyRumcajs LesnyRumcajs enabled auto-merge March 9, 2026 10:01
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 9, 2026

Walkthrough

Four new environment variables (FOREST_PLEDGE_RULE_RAMP, FOREST_DRAND_INCENTINET_CONFIG, FOREST_GENESIS_NETWORK_VERSION, FOREST_TIPSET_CACHE_DISABLED) were added to the environment variables reference with type, default, example, and description entries.

Changes

Cohort / File(s) Summary
Environment Variables Documentation
docs/docs/users/reference/env_variables.md
Added four new environment variable entries: FOREST_PLEDGE_RULE_RAMP, FOREST_DRAND_INCENTINET_CONFIG, FOREST_GENESIS_NETWORK_VERSION, and FOREST_TIPSET_CACHE_DISABLED (type, default, example, description).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

  • hanabi1224
  • akaladarshi
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding new environment variables to the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch env-var-update

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/docs/users/reference/env_variables.md (1)

64-64: Consider calling out the Lotus name here.

Operators migrating from Lotus may look for LOTUS_GENESIS_NETWORK_VERSION, so a brief note that this is Forest’s equivalent would make the docs a bit more discoverable.

✏️ Suggested wording
-| `FOREST_GENESIS_NETWORK_VERSION`                          | non-negative integer            | empty                                          | 25                                                            | Override the genesis network version (devnet only)                                                                    |
+| `FOREST_GENESIS_NETWORK_VERSION`                          | non-negative integer            | empty                                          | 25                                                            | Override the genesis network version (devnet only). Forest-specific equivalent of Lotus's `LOTUS_GENESIS_NETWORK_VERSION` |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/docs/users/reference/env_variables.md` at line 64, Update the env var
description for FOREST_GENESIS_NETWORK_VERSION to explicitly mention Lotus by
adding a short note like "This is Forest's equivalent of
LOTUS_GENESIS_NETWORK_VERSION" so operators migrating from Lotus can find it;
locate the table row referencing FOREST_GENESIS_NETWORK_VERSION in
docs/users/reference/env_variables.md and append the suggested clarifying text
to the description cell for that symbol.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/docs/users/reference/env_variables.md`:
- Line 64: Update the env var description for FOREST_GENESIS_NETWORK_VERSION to
explicitly mention Lotus by adding a short note like "This is Forest's
equivalent of LOTUS_GENESIS_NETWORK_VERSION" so operators migrating from Lotus
can find it; locate the table row referencing FOREST_GENESIS_NETWORK_VERSION in
docs/users/reference/env_variables.md and append the suggested clarifying text
to the description cell for that symbol.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: e08268a1-4a56-43fa-ae00-6b3cb67c451c

📥 Commits

Reviewing files that changed from the base of the PR and between c34ddf0 and f0b160c.

📒 Files selected for processing (1)
  • docs/docs/users/reference/env_variables.md

@LesnyRumcajs LesnyRumcajs added this pull request to the merge queue Mar 9, 2026
Merged via the queue into main with commit 87b3ff1 Mar 9, 2026
11 checks passed
@LesnyRumcajs LesnyRumcajs deleted the env-var-update branch March 9, 2026 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants