Skip to content

docs: highlight CI Git environment configuration instruction#6

Merged
babblebey merged 3 commits into
betafrom
docs/git-config
Jun 18, 2026
Merged

docs: highlight CI Git environment configuration instruction#6
babblebey merged 3 commits into
betafrom
docs/git-config

Conversation

@babblebey

Copy link
Copy Markdown
Member

This pull request updates the README.md to clarify the responsibilities of composed callers (such as wrapper packages or direct invocations) regarding Git environment configuration in CI environments. It highlights that @semantic-release/core does not set Git defaults for composed callers, and provides explicit guidance and code examples to prevent common CI failures related to Git author identity and credential prompts.

Documentation improvements for CI and Git environment configuration:

  • Added a clear explanation that composed callers must configure the Git process environment (e.g., GIT_AUTHOR_NAME, GIT_COMMITTER_NAME, GIT_ASKPASS, GIT_TERMINAL_PROMPT) before invoking @semantic-release/core, as core does not inject these defaults for them. [1] [2]
  • Provided a typical CI setup code example showing how to set the necessary Git environment variables to avoid failures during publishing in non-interactive environments. [1] [2]
  • Updated documentation to emphasize that wrapper/caller code owns Git process environment hardening and should set these variables before invoking core.

@babblebey
babblebey merged commit 26482d7 into beta Jun 18, 2026
8 checks passed
@babblebey
babblebey deleted the docs/git-config branch June 18, 2026 15:05
@github-actions

Copy link
Copy Markdown

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

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