Skip to content

docs: clarify git process environment defaults#10

Merged
babblebey merged 2 commits into
betafrom
doc/git-nits
Jul 2, 2026
Merged

docs: clarify git process environment defaults#10
babblebey merged 2 commits into
betafrom
doc/git-nits

Conversation

@babblebey

Copy link
Copy Markdown
Member

This pull request updates the documentation in README.md to clarify how Git process environment defaults are handled in CI workflows when using @semantic-release/core. The changes reorganize and expand the explanation of environment variable defaults, making it clearer for users how and when to set or override these values.

Key documentation improvements:

Clarification and reorganization of Git environment variable defaults:

  • Moved and expanded the explanation of Git process environment defaults to a dedicated section, providing a clearer example of how callers should set these variables for CI environments.
  • Updated the example email addresses in the environment variable setup to use the official semantic-release.org domain for clarity and consistency.
  • Clarified that core applies its own defaults for any Git environment values not set by the caller, and that these remain overridable. [1] [2]

Streamlining and removal of redundant documentation:

  • Removed redundant and outdated explanations regarding environment variable handling from earlier sections to avoid confusion and duplication. [1] [2]
  • Updated references to environment variable hardening in the dependency and ownership model section to point to the new, dedicated section for easier navigation.

@babblebey
babblebey merged commit 9a6c653 into beta Jul 2, 2026
8 checks passed
@babblebey
babblebey deleted the doc/git-nits branch July 2, 2026 18:57
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.0.0-beta.3 🎉

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant