GitHasStagedChanges only considers modified files, not new/deleted/renamed

[andreasnilsen]

Looking at the source code for LibGit2Sharp's RepositoryStatus, it seems that the "Staged" list only contains existing files that were modified, not files that were added, deleted or renamed. These are stored in separate lists.
https://github.com/libgit2/libgit2sharp/blob/f8e2d42ed9051fa5a5348c1a13d006f0cc069bc7/LibGit2Sharp/RepositoryStatus.cs#L42

return new Dictionary<FileStatus, Action<RepositoryStatus, StatusEntry>>
            {
                { FileStatus.NewInWorkdir, (rs, s) => rs.untracked.Add(s) },
                { FileStatus.ModifiedInWorkdir, (rs, s) => rs.modified.Add(s) },
                { FileStatus.DeletedFromWorkdir, (rs, s) => rs.missing.Add(s) },
                { FileStatus.NewInIndex, (rs, s) => rs.added.Add(s) },
                { FileStatus.ModifiedInIndex, (rs, s) => rs.staged.Add(s) },
                { FileStatus.DeletedFromIndex, (rs, s) => rs.removed.Add(s) },
                { FileStatus.RenamedInIndex, (rs, s) => rs.renamedInIndex.Add(s) },
                { FileStatus.Ignored, (rs, s) => rs.ignored.Add(s) },
                { FileStatus.RenamedInWorkdir, (rs, s) => rs.renamedInWorkDir.Add(s) },
            };
        }

The Cake.Git method GitAliases.Repository.GitHasStagedChanges only checks the RepositoryStatus.Staged list, not the NewInIndex, DeletedFromIndex, RenamedInIndex.

Cake_Git/src/Cake.Git/GitAliases.Repository.cs

Lines 101 to 121 in ad0b56e

	public static bool GitHasStagedChanges(this ICakeContext context, DirectoryPath path)
	{
	if (context == null)
	{
	throw new ArgumentNullException(nameof(context));
	}
	if (path == null)
	{
	throw new ArgumentNullException(nameof(path));
	}
	if (!context.FileSystem.Exist(path))
	{
	throw new RepositoryNotFoundException($"Path '{path}' doesn't exists.");
	}
	return context.UseRepository(
	path,
	repository => repository.RetrieveStatus().Staged.Any());
	}

So if your changes only contain new files/deleted files/renamed files, GitHasStagedChanges will return false.

I'm not an expert on Git terminology, but I believe "staged" means any changes staged for commit, not just modified files?

If so, I guess it's a matter of discussion where the error lies, LibGit2Sharp's naming of the Staged-list is maybe a bit unfortunate, but I also guess that Cake.Git is consuming the RepositoryStatus "API" wrongly?

[devlead]

@andreasnilsen to not break anything, perhaps add an GitHasChanges alias that checks all places?

[andreasnilsen]

@devlead I understand your concern, but imho that name is a bit vague, it's not intuitive to me how it relates to/differs from GitHasUncommitedChanges (which will consider any file that is not ignored or unaltered as a change, including both unstaged and staged files), and some people are already using the existing method in the belief that it will consider all staged files. How about GitHasIndexedChanges, which was the original name of the GitHasStagedChanges? And maybe mark GitHasStagedChanges for deprecation?

Or maybe give it an optional flags enum for the places as an argument, which defaults to only modified files, i.e. current the functionality?

[benfoster]

I also ran into this today when pushing to my gh-pages branch for the first time. I've replaced it with GitHasUncommitedChanges but this is not ideal either as this doesn't necessarily mean the changes have been staged.