Skip to content

docs: add a "deep dive" on environment variables#43243

Merged
jamietanna merged 1 commit into
mainfrom
docs/env-var-deep-div
May 29, 2026
Merged

docs: add a "deep dive" on environment variables#43243
jamietanna merged 1 commit into
mainfrom
docs/env-var-deep-div

Conversation

@jamietanna

@jamietanna jamietanna commented May 11, 2026

Copy link
Copy Markdown
Contributor

Changes

As part of recent work around environment variable handling, it's clear
we should provide more user-facing documentation on how environment
variables are handled, and which are passed to child processes by
default.

We can create a "deep dive" page for this, with an autogenerated list of
the environment variables in basicEnvVars that are always passed to
child processes, if they're set.

We can also point self-hosted administrators and users alike to the
options they have to control this, too.

Context

Please select one of the below:

  • This closes an existing Issue: Closes #
  • This doesn't close an Issue, but I accept the risk that this PR may be closed if maintainers disagree with its opening or implementation

AI assistance disclosure

Did you use AI tools to create any part of this pull request?

Please select one option and, if yes, briefly describe how AI was used (e.g., code, tests, docs) and which tool(s) you used.

  • No — I did not use AI for this contribution.
  • Yes — minimal assistance (e.g., IDE autocomplete, small code completions, grammar fixes).
  • Yes — substantive assistance (AI generated non‑trivial portions of code, tests, or documentation).
  • Yes — other (please describe):

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

The public repository:

Comment thread docs/usage/.pages Outdated
Comment thread docs/usage/environment-variable-handling.md
Comment thread docs/usage/environment-variable-handling.md Outdated
Comment thread docs/usage/environment-variable-handling.md Outdated
Comment thread docs/usage/environment-variable-handling.md
Comment thread lib/util/exec/env.ts
Base automatically changed from chore/no-replaceStop to main May 13, 2026 15:57
@jamietanna jamietanna force-pushed the docs/env-var-deep-div branch from b0ad649 to 7af078e Compare May 18, 2026 16:12
Comment thread docs/usage/environment-variable-handling.md
@jamietanna

jamietanna commented May 22, 2026

Copy link
Copy Markdown
Contributor Author

@viceice viceice left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, can't see the diagrams on mobile 😅

@jamietanna jamietanna force-pushed the docs/env-var-deep-div branch 2 times, most recently from 9b5aaee to 5c65357 Compare May 26, 2026 16:34
@jamietanna jamietanna marked this pull request as ready for review May 26, 2026 16:34
@github-actions github-actions Bot requested a review from viceice May 26, 2026 16:34
Comment thread docs/usage/environment-variable-handling.md Outdated
Comment thread docs/usage/templates.md Outdated
As part of recent work around environment variable handling, it's clear
we should provide more user-facing documentation on how environment
variables are handled, and which are passed to child processes by
default.

We can create a "deep dive" page for this, with an autogenerated list of
the environment variables in `basicEnvVars` that are always passed to
child processes, if they're set.

We can also point self-hosted administrators and users alike to the
options they have to control this, too.

With help from GPT-4.1 for case-insensitive sorting.

Co-authored-by: Claude Sonnet 4.6 <jamie.tanna+claude-code@mend.io>
Co-authored-by: gpt-4.1 <jamie.tanna+github-copilot@mend.io>
@jamietanna jamietanna force-pushed the docs/env-var-deep-div branch from 5c65357 to 45d6267 Compare May 29, 2026 15:04
@jamietanna

Copy link
Copy Markdown
Contributor Author

OK, rebased + made a few more amends per Sebastian's comments - otherwise good for a re-review and good to go!

@jamietanna jamietanna requested a review from secustor May 29, 2026 15:05
@jamietanna jamietanna added this pull request to the merge queue May 29, 2026
Merged via the queue into main with commit cbd174e May 29, 2026
@jamietanna jamietanna deleted the docs/env-var-deep-div branch May 29, 2026 15:15
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 43.204.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

5 participants