Skip to content

Comments

docs: add git config user.* to commit successfully#1877

Merged
bearomorphism merged 1 commit intomasterfrom
commit-doc-gif-fix
Feb 23, 2026
Merged

docs: add git config user.* to commit successfully#1877
bearomorphism merged 1 commit intomasterfrom
commit-doc-gif-fix

Conversation

@bearomorphism
Copy link
Collaborator

Fixes #1876

Verified the solution by running vhs docs/images/commit.tape, and the generated /tmp/commitizen-demo folder is with correct git log (with a commit authored by you@example.com)

@bearomorphism
Copy link
Collaborator Author

@HankyStyle do you want to take a look on this fix?

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes the broken commit.gif generation in the documentation by adding git user configuration commands to the VHS tape file. The issue occurred because GitHub Actions environments don't have git user.name and user.email configured by default, causing commits to fail during the automated screenshot generation process.

Changes:

  • Added git config user.email and git config user.name commands to the commit.tape VHS recording script

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@HankyStyle
Copy link
Contributor

Yes, this PR fixes the issue. The problem wasn't caught earlier because I had global git config set locally, so it always worked on my machine.

Thanks @bearomorphism for the fix!

I've tested it with clean environment and confirmed it works correctly.

Before:

Screenshot at Feb 23 19-38-34

After:
commit_success_final_success_1771850407987

@bearomorphism
Copy link
Collaborator Author

Thanks for double confirming that this PR actually fixes the issue :)

@bearomorphism bearomorphism merged commit 6c3107c into master Feb 23, 2026
22 checks passed
@bearomorphism bearomorphism deleted the commit-doc-gif-fix branch February 23, 2026 13:54
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.

Broken commit.gif in docs

3 participants