Как настроить драйвер git для игнорирования папки при слиянии

Я уже провел обширный поиск, прочитал много вопросов и решений SO и попробовал разные способы, но я не смог сделать то, что хочу, что довольно просто.

У меня есть главная ветвь, где находится весь основной код, и ветвь дизайна, где компоновка приложения rails построена командой разработчиков. Они добавили в общую папку папку "photoshop", чтобы сохранить источники для изображений также под управлением версиями. Но я не хочу, чтобы эта папка была скопирована при слиянии с главной ветвью, потому что, ну, она не нужна.

По-видимому, способ сделать это через драйвер слияния. Итак, я создал драйвер "ignore":

[merge "ignore"]
name = always ignore during merge
driver = ignore.sh %0 %A %B

И создал файл ignore.sh на моем $PATH:

exit 0

Я создал файл .gitattributes внутри public/, потому что папку photoshop следует игнорировать целиком, и она появится под общим /:

photoshop  merge=ignore
photoshop/ merge=ignore
photoshop/* merge=ignore
photoshop/**/* merge=ignore

Как вы можете видеть, я пробовал несколько разных шаблонов, чтобы игнорировать всю папку, но она не работает. Я считаю, что это потому, что на главной ветке нет папки, поэтому нет конфликта, поэтому git не использует драйвер игнорирования. Есть ли способ достичь этого, не создавая папку public/photoshop на master?

Спасибо!

Ответы

Ответ 1

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

(да, мне было скучно дома и больше нечего было делать: P)

Этот script добавит новую отдельную фиксацию на основе вашей локальной ветки дизайна, поэтому она не повлияет ни на репозиторий проекта, ни на вашу ветку дизайна. У фиксации будут удалены все нужные файлы. Затем он выполняет слияние.

Для тех, кто слишком ленив, чтобы прочитать полный код, "ядро" этих шагов можно упростить, например:

original=$(gitbranch HEAD)    # current branch name, or sha1 if not in a branch
branchsha=$(gitsha "$branch") # sha1 of a ref, to force detached commit

git checkout "$branchsha"   &&
git rm -rf "${files[@]}"    &&
git commit -m "$msgcommit"  &&
newsha=$(gitsha HEAD)       &&
git checkout "$original"    &&
git merge -m "$msgmerge" "${mergeopts[@]}" "$newsha"

И вот полный script:

(немного модифицированный, чтобы справиться со слабой и ограниченной синтаксической синтаксией SO, поэтому лучше получить исходный источник из ссылки ниже)

git-strip-merge

#!/bin/bash
#
# git-strip-merge - a git-merge that delete files on branch before merging
#
#    Copyright (C) 2012 Rodrigo Silva (MestreLion) <[email protected]>
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program. If not see <http://www.gnu.org/licenses/gpl.html>
#
# Answer for "How to setup a git driver to ignore a folder on merge?"
# See http://stackoverflow.com/questions/3111515

#Defaults:
msgcommit="remove files from '<branch>' before merge"
msgmerge="Merge stripped branch '<branch>'"
verbose=0
quiet=(--quiet)

usage() {
    cat <<- USAGE
    Usage: $myname [git-merge options] [-M <commitmsg>] <branch> FILE...
    USAGE
    if [[ "$1" ]] ; then
        cat >&2 <<- USAGE
        Try '$myname --help' for more information.
        USAGE
        exit 1
    fi
    cat <<-USAGE

    "git-merge that delete files on "foreign" <branch> before merging

    Useful for ignoring a folder in <branch> before merging it with
    current branch. Works by deleting FILE(S) in a detached commit based
    on <branch>, and then performing the merge of this new commit in the
    current branch. Note that <branch> is not changed by this procedure.
    Also note that <branch> may actually be any reference, like a tag,
    or a remote branch, or even a commit SHA.

    For more information, see <http://stackoverflow.com/questions/3111515>

    Options:
      -h, --help
         show this page.

      -v, --verbose
         do not use -q to supress normal output of internal steps from git
         checkout, rm, commit. By default, only git merge output is shown.
         Errors, however, are never supressed

      -M <message>, --msgcommit=<message>
         message for the removal commit in <branch>. Not to be confused
         with the message of the merge commit, which is set by -m. Default
         message is: "$msgcommit"

      -m <message>, --message=<message>
         message for the merge commit. Since we are not merging <branch>
         directly, but rather a detached commit based on it, we forge a
         message similar to git default for a branch merge. Otherwise
         git would use in message the full and ugly SHA1 of our commit.
         Default message is: "$msgmerge"

      For both commit messages, the token "<branch>" is replaced for the
      actual <branch> name.

    Additional options are passed unchecked to git merge.

    All options must precede <branch> and FILE(s), except -h and --help
    that may appear anywhere on the command line.

    Example:
      $myname design "photoshop/*"

    Copyright (C) 2012 Rodrigo Silva (MestreLion) <[email protected]>
    License: GPLv3 or later. See <http://www.gnu.org/licenses/gpl.html>"
    USAGE
    exit 0
}

# Helper functions
myname="${0##*/}"
argerr()  { printf "%s: %s\n" "${0##*/}" "${1:-error}" >&2 ; usage 1 ; }
invalid() { argerr "invalid option: $1" ; }
missing() { argerr "missing ${2:+$2 }operand${1:+ from $1}." ; }

# Option handling
files=()
mergeopts=()
for arg in "[email protected]"; do case "$arg" in -h|--help) usage ;; esac; done
while (( $# )); do
    case "$1" in
    -v|--verbose  ) verbose=1            ;;
    -M            ) shift ; msgcommit=$1 ;;
    -m            ) shift ; msgmerge=$1  ;;
    --msgcommit=* ) msgcommit=${1#*=}    ;;
    --message=*   ) msgmerge=${1#*=}     ;;
    -*            ) mergeopts+=( "$1" )  ;;
    *             ) branch="$1"
                    shift ; break        ;;
    esac
    shift
done
files+=( "[email protected]" )

# Argument handling

msgcommit=${msgcommit//<branch>/$branch}
msgmerge=${msgmerge//<branch>/$branch}

[[ "$msgcommit" ]]  || missing "msgcommit" "MSG"
[[ "$branch"   ]]   || missing ""          "<branch>"
(( ${#files[@]} ))  || missing ""          "FILE"

((verbose)) && quiet=()

# Here the fun begins...
gitsha()    { git rev-parse "$1" ; }
gitbranch() {
    git symbolic-ref "$1" 2> /dev/null | sed 's/refs\/heads\///' ||
    gitsha "$1"
}

original=$(gitbranch HEAD)
branchsha=$(gitsha "$branch")

trap 'git checkout --quiet "$original"' EXIT

git checkout "$branchsha"  "${quiet[@]}" &&
git rm -rf "${files[@]}"   "${quiet[@]}" &&
git commit -m "$msgcommit" "${quiet[@]}" &&
newsha=$(gitsha HEAD)                    &&
git checkout "$original"   "${quiet[@]}" &&
git merge -m "$msgmerge" "${mergeopts[@]}" "$newsha"

Наслаждайтесь!

Изображение стоит больше тысячи слов...

Перед слиянием:

enter image description here

После слияния:

enter image description here

Обратите внимание, что кончик ответвления "дизайн" вообще не был затронут, даже будучи локальной ветвью, благодаря отключенному трюку с фиксацией. Помимо этого, оба фиксации (удаление и слияние) являются регулярными фиксациями, с соответствующими сообщениями о совершении и родителями. И ветка "master" очищена от любых нежелательных файлов.

Ответ 2

Не ответ сам по себе, но несколько заметок о .gitignore: он поможет не в вашем сценарии.

.gitignore предназначен для игнорирования файлов из рабочего дерева, которые будут добавлены в индекс (область постановки). Поэтому он эффективен только при использовании git add <files>, и его можно переопределить с помощью git add --force <files>. Это подразумевается как удобство для предотвращения добавления нежелательных файлов, но оно имеет не влияет на файлы внутри репозитория

В вашем сценарии .gitignore не требуется, так как у вас нет локальной папки ./photoshop, поэтому у вас никогда не будет никаких файлов для фотошоп, которые нужно добавить в свою основную ветку. Однако это не помешает создать на всякий случай. И для команды дизайнеров .gitignore не приветствуется, так как они хотят добавлять файлы photoshop в свою ветку.

Итак, поскольку слияние связано с данными, и ./photoshop файлы уже находятся в репозитории, ваш подход к использованию драйвера слияния был правильным.

Проблема заключается в том, что по умолчанию драйвер слияния запускается только в случае конфликтов. И поскольку ветка master не имеет какой-либо папки или файлов ./photoshop, конфликтов вообще нет, они чисто объединяются. Таким образом, ваш драйвер слияния также не имел никакого эффекта, независимо от ваших шаблонов пути (кстати, ваш второй, photoshop/, был правильным). Я не знаю, можно ли сконфигурировать git merge, чтобы запускать драйвер слияния даже для не конфликтующих файлов, но он стоит искать в Google.

Как я уже говорил, мой ответ не является истинным решением вашей проблемы. Я просто надеялся пролить свет на эту тему, объяснив, почему ваши попытки использовать драйвер слияния и .gitignore не удались. Я предлагаю больше узнать о (с настройке) слияния драйверов. Также следует исследовать подмодули.

Надеюсь, это поможет!

UPDATE

Возможно, мой другой ответ поможет вам:

Usage: git-strip-merge [git-merge options] [-M <commitmsg>] <branch> FILE...

git-strip-merge

Наслаждайтесь!

Ответ 3

Вы пытались добавить файл .gitignore в ветку master, чтобы игнорировать содержимое каталога photopshop?

Тогда слияние от дизайна до master не должно добавлять этот новый каталог в master.

Если это работает, вам все равно нужен драйвер слияния, но на этот раз для управления содержимым файла .gitignore.