docs: highlight CI Git environment configuration instruction#6
Merged
Conversation
|
🎉 This PR is included in version 1.0.0-beta.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the
README.mdto 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/coredoes 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:
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]