Add support for "git revert"

[koppor]

Version

0.12.16

Operating System

Windows

Distribution Method

msi (Windows)

Describe the issue

I ran git revert {some-commit-id}. The revert was correctly added to the virtual branch. However, there was another branch created.

Now I cannot work with git butler any more, because it complains

The given reference name 'refs/gitbut1er/Revert-"Remove-
comments---don't-work-on-forks"-This-reverts-commit-
a3ab7d5c36e5b6d212a5de8b87Ø6b81d7ec9362e.' is not valid;
class-Reference (4); coae=Inva1idSpec (-12)

How to reproduce

Use git revert {some comit it}

Expected behavior

The virtual branch Revert "..." is not created at all.

Relevant log output

No response

[mtsgrd]

@Byron I think you've looked branch name normalization? There are sort of two problems here from a users perspective, first that a revert creates a new branch (but this is currently by design), but the invalid branch name is from what understand a new thing. The error message comes from libgit2: https://github.com/libgit2/libgit2/blob/503b66cf00ad7dca940148529f60b1a409ccc462/src/libgit2/refs.c#L1017

[Byron]

Indeed, this has been improved and it will now fail early, during normalization, as it detects invalid branch names before they are used (like is the case with the error message indicating git2 tried to create or update a branch of that name`).

I even was able to reproduce the issue, but could also recover from it with Version 0.12.16 (20240730.095735) doing the following:

• run git revert @ on with gitbutler/integration checked out
• refresh two times with Cmd+R
• find the new virtual branch 'magically' created

When deleting it, there is an error message, but the deletion works. Trying to rename it fails as it can't do anything with the incorrect branch name. It's interesting that the branch-name normalization doesn't kick-in at all, it's not called it seems as it wouldn't be able to build a branch named refs/gitbutler/Revert-"GitButler-Integration-Commit"-This-reverts-commit-d6efa5fd96d36da445d5d1345b84163f05f5f229. with it.

And I put a test down and it's clear that the branch name it normalizes passes: Revert-"GitButler-Integration-Commit"-This-reverts-commit-d6efa5fd96d36da445d5d1345b84163f05f5f229.. And indeed, it's a valid branch name as far as git is concerned.

git also thinks it's invalid:

❯ git branch 'Revert-"GitButler-Integration-Commit"-This-reverts-commit-d6efa5fd96d36da445d5d1345b84163f05f5f229.'
fatal: 'Revert-"GitButler-Integration-Commit"-This-reverts-commit-d6efa5fd96d36da445d5d1345b84163f05f5f229.' is not a valid branch name

The culprit seems to be the trailing .! Let me fix that in gitoxide, which strangely let's it pass even though I thought I modelled this after the Git source code.

[Byron]

I made some improvements and now the trailing . is forbidden as well. The code I altered was from 2021, and I even had a passing test claiming that trailing . should work. Apparently, Git changed its stance over time.

As CI takes a moment, I will integrate the changes with GitButler tomorrow and see what will happen then when repeating this workflow.