Программная печать git-ревизии и проверка на незафиксированные изменения

Question

Чтобы убедиться, что мой научный анализ воспроизводим, я хотел бы программно проверить, есть ли какие-либо модификации в кодовой базе, которые не зарегистрированы, и если нет, распечатать, какой коммит используется.

Например, если есть незафиксированные изменения, он должен вывести

Warning: uncommitted changes made. This output may not be reproducible.

Остальное, производим

Current commit: d27ec73cf2f1df89cbccd41494f579e066bad6fe

В идеале следует использовать «сантехнику», а не «фарфор».

Answer 1

Нужные биты сантехники Git diff-index, rev-parse --verify и, возможно, rev-parse --show-cdup с ls-files --others.

Следующая программа-оболочка использует эти команды Git, имеет настраиваемую обработку без отслеживания / игнорирования и довольно осторожна во всех возможных случаях ошибок.

#!/bin/sh

# warn-unclean: print a warning if the working tree and index are not clean

#  For utmost strictness, set check_untracked=yes and check_ignored=yes.
#  When both are 'yes', verify that working tree and index are identical to HEAD.
#  When only check_untracked is yes, extra ignored files are allowed.
#  When neither is yes, extra untracked files and ignored files are allowed.

check_untracked=yes
check_ignored=yes

warn() {
    echo 'Warning: '"$*" \
        'This output may not be reproducible.'
}

# Compare HEAD to index and/or working tree versions of tracked files
git diff-index --quiet HEAD
case $? in
    0)
        if test "$check_untracked" != yes; then
            clean=yes
        else
            # Still need to check for untracked files

            or_ignored=''
            exclude=--exclude-standard
            if test "$check_ignored" = yes; then
                or_ignored=' or ignored'
                exclude=''
            fi

            (
                # Move to top level of working tree
                if up="$(git rev-parse --show-cdup)"; then
                    test -n "$up" && cd "$up"
                else
                    echo 'error running "git rev-parse --show-cdup"'
                    exit 129
                fi

                # Check for untracked files
                git ls-files --others $exclude --error-unmatch . >/dev/null 2>&1
                case $? in
                    0)  # some untracked/ignored file is present
                        warn 'some untracked'"$or_ignored"' file is present.'
                        exit 1
                    ;;
                    1)  # no untracked files
                        exit 0
                    ;;
                    *)
                        echo 'error running "git diff-index"!'
                        exit 129
                    ;;
                esac

            )
            case $? in
                0) clean=yes ;;
                1) clean=no ;;
                *) exit $? ;;
            esac
        fi

        test "$clean" = yes &&
        if c="$(git rev-parse --verify HEAD)"; then
            echo 'Current commit: '"$c"
        else
            echo 'error running "git rev-parse --verify"!'
        fi
    ;;
    1)
        warn 'some tracked file has an uncommitted change.'
    ;;
    *)
        echo 'error running "git diff-index"!'
        exit 129
    ;;
esac

Вы можете добавить еще exit s, если вы хотите, чтобы его код выхода имел смысл во всех случаях.

Если вам не нужна вся обработка ошибок или обработка без отслеживания / игнорирования, то может быть достаточно короткого:

if git diff-index --quiet; then
    printf 'Current commit: %s\n' "$(git rev-parse --verify HEAD)
else
    echo 'Warning: …'
fi

Вы также можете кратко проверить наличие неотслеживаемых файлов (которые можно настроить для игнорирования и т. Д.) Без обработки ошибок:

git ls-files --others --exclude-standard --error-unmatch \
    "./$(git rev-parse --show-cdup)" >/dev/null 2>&1

Answer 2

Используется фарфор, но git diff --exit-code завершается с 1, если существуют различия с существующими файлами, и с 0, если нет различия с существующими файлами. К сожалению, он не проверяет наличие неотслеживаемых файлов.

Этот ответ Как получить хеш для текущего коммита в Git? призывает git rev-parse --verify HEAD напечатать текущий коммит.