Позначте файл як "незручний" за допомогою 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слід налаштувати файл, 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глобально, то ви знаєте, що це не буде скоєно, навіть якщо ви забудете окремо виключити цей конкретний файл.