Пометить файл как «uncommitable» с помощью Git

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

Есть ли способ пометить файл как недоступный для Git, чтобы он не мог появиться на GitHub?

Есть ли способ пометить файл как недоступный для Git, чтобы он не мог появиться на GitHub?

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

Во-вторых, не существует простого и практичного способа пометить отдельный файл как «непригодный для использования». Но определенно есть способ игнорировать файл в репозитории Git: добавляя файлы, включая их относительный путь, если необходимо - в .gitignoreфайл :

.gitignoreФайл определяет намеренно неотслеживаемые файлы, Git должны игнорировать. Файлы, уже отслеженные Git, не затрагиваются; см. примечания ниже для деталей.

Создать простой .gitignoreдовольно просто, так как это простой текстовый файл. Так, например, если бы у меня был config.phpфайл в вашем корне, вы бы сделали это; Предполагается, что вы используете PHP, но концепция применима для любой установки. Также я использую Nano в качестве моего текстового редактора в этом примере, но не стесняйтесь использовать любой текстовый редактор, который вы обычно используете для этого:

nano .gitignore

И просто добавьте это имя файла в этот файл:

config.php

Сохраните его, и теперь Git просто проигнорирует этот файл.

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

config.SAMPLE.php

Таким образом, вы точно знаете, как config.phpфайл должен быть настроен через Git, config.SAMPLE.phpи вы можете быть уверены, что config.phpGit никогда не затрагивает его.

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

Вы также можете добавить хук перед фиксацией для реализации проверок работоспособности. В каталоге .git/hooksкаждого репозитория git есть несколько примеров скриптов.

Вызываемый скрипт pre-commitвыполняется, если он существует перед каждым коммитом, и ненулевое возвращаемое значение отменяет коммит.

Например, у вас может быть простой скрипт вроде этого:

#! /bin/sh -e
git ls-files --cached | grep -qx 'filename' && { echo "Excluded file included in the commit" >&2; exit 1; }
exit 0

И если это filenameсовпадает, фиксация завершается неудачно.

Что сказал @JakeGould. В некоторых случаях вы также можете использовать специальные биты файлов, такие как skip-worktreeили assume-unchangedкоторые могут быть установлены следующим образом; различия между ними см. в ответе «Переполнение стека» :

git update-index --assume-unchanged <file>

Который затем будет скрывать дополнительные изменения в уже существующем файле и который вы можете использовать, если вы действительно хотите, чтобы файл был там после каждого извлечения. Но я бы посоветовал вам использовать его, только если вы действительно знаете, что делаете.

Используйте .gitignoreкак @JakeGould сказал. Кроме того, некоторая связанная информация:

• .gitignoreпредотвращает отслеживание файлов; если они уже отслежены, используйте git rm --cachedдля их удаления
• файлы / шаблоны в $GIT_DIR/info/excludeтакже будут игнорироваться
• файлы / шаблоны в файле, указанном в файле core.excludesFile пользователя, ~/.gitconfigтакже игнорируются.

Смотрите официальную документацию Git для более подробной информации.

Чтобы расширить на вопросы Джейка и 46: одна очень хорошая практика - иметь постоянное расширение, которое вы используете для файлов, в которые вы включаете личную информацию, и использовать, .gitignoreчтобы всегда исключать файлы с таким расширением глобально (используя .gitconfigфайл, как упоминалось в другом месте, чтобы его всегда игнорировали для вашего пользователя).

Таким образом, вы можете иметь, например:

/projectname/mypasswords.exc 

и если вы исключили *.excглобально, то вы знаете, что оно не будет зафиксировано, даже если вы забудете отдельно исключить этот конкретный файл.