Oznacz Git jako „niekomfortowy”

Chcę pochwalić się niektórymi z moich prac, przesyłając je na moje konto GitHub. Istnieją jednak pliki zawierające hasła, na przykład połączenia z bazą danych.

Czy istnieje sposób oznaczenia pliku jako nieprzydatnego w Git, aby nie mógł pojawić się w GitHub?

Czy istnieje sposób oznaczenia pliku jako nieprzydatnego w Git, aby nie mógł pojawić się w GitHub?

Po pierwsze, nie ma sposobu, aby niektóre pliki i zatwierdzenia były widoczne w lokalnym repozytorium Git, ale w jakiś sposób nie były widoczne w GitHub; jeśli masz plik zatwierdzony w Git, pojawi się w GitHub.

Po drugie, nie ma prostego i praktycznego sposobu, aby oznaczyć sam plik jako „niepospolity”. Ale jest zdecydowanie sposób na zignorowanie pliku w repozytorium Git: Dodając plik (i) - w tym ich ścieżkę względną, jeśli potrzebne - do .gitignorepliku :

.gitignorePlik określa na zamierzone nieśledzone pliki Git powinny ignorować. Nie ma to wpływu na pliki już śledzone przez Git; szczegóły patrz UWAGI poniżej.

Utworzenie podstawowego .gitignorejest dość łatwe, ponieważ jest to zwykły plik tekstowy. Więc - na przykład - gdybym miał config.phpplik w twoim katalogu głównym, zrobiłbyś to; zakładając, że używasz PHP, ale koncepcja ma zastosowanie do każdej konfiguracji. Używam również Nano jako mojego edytora tekstu w tym przykładzie, ale możesz użyć dowolnego edytora tekstu, którego normalnie używasz do tego:

nano .gitignore

I po prostu dodaj tę nazwę pliku do tego pliku:

config.php

Zapisz go, a teraz Git po prostu zignoruje ten plik.

To powiedziawszy, co lubię robić dla takich konfiguracji, to pozostawienie konfiguracji repozytorium próbki / przykładu neutralnej wrażliwej specyfiki w repozytorium, więc mam pewne odniesienie do tego, jaki format pliku konfiguracyjnego to plik o nazwie coś takiego:

config.SAMPLE.php

W ten sposób wiesz dokładnie, jak config.phpplik powinien zostać skonfigurowany config.SAMPLE.phpi możesz upewnić się, że config.phpGit nigdy nie dotknie faktycznego .

Ponadto, jeśli planujesz pochwalić się swoim kodem, musisz spodziewać się, że ktoś spróbuje go pobrać i w jakiś sposób zaimplementować w swoim systemie. Pamiętaj, że nie jesteśmy tobą i bez przykładowego pliku konfiguracyjnego w repozytorium ludzie naprawdę nie zrozumieją, jak samodzielnie wdrożyć kod. Cholera, mogą nawet myśleć, że nie jesteś kompetentny, ponieważ nie podałeś podstawowego przykładu konfiguracji.

Możesz także dodać hak poprzedzający zatwierdzenie, aby zaimplementować kontrolę poczytalności. Katalog .git/hookskażdego repozytorium git zawiera kilka przykładowych skryptów.

Wywołany skrypt pre-commitjest wykonywany, jeśli istnieje przed każdym zatwierdzeniem, a niezerowa wartość zwrotna przerywa zatwierdzenie.

Na przykład możesz mieć taki prosty skrypt:

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

A jeśli to filenamepasuje, zatwierdzenie nie powiedzie się.

Co powiedział @JakeGould. W niektórych przypadkach można również użyć specjalnych bitów pliku, takich jak skip-worktreelub, assume-unchangedktóre można ustawić w następujący sposób; różnice między nimi znajdują się w odpowiedzi na Przepełnienie stosu :

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

Który następnie ukryje dodatkowe zmiany w już istniejącym pliku i którego możesz użyć, jeśli naprawdę chcesz, aby plik był tam po każdym ściągnięciu. Ale radziłbym ci go używać tylko wtedy, gdy naprawdę wiesz, co robisz.

Użyj .gitignorepodobnego @JakeGould powiedział. Ponadto niektóre powiązane informacje:

• .gitignorechroni pliki przed śledzeniem; jeśli są już śledzone, użyj ich git rm --cacheddo usunięcia
• pliki / wzorce w $GIT_DIR/info/excluderównież zostaną zignorowane
• pliki / wzorce w pliku określonym przez core.excludesFile użytkownika ~/.gitconfigrównież są ignorowane.

Więcej informacji znajduje się w oficjalnej dokumentacji Git .

Aby rozszerzyć odpowiedzi Jake'a i 46: jedną bardzo dobrą praktyką jest posiadanie spójnego rozszerzenia, którego używasz dla plików, w których umieszczasz prywatne informacje, i .gitignorezawsze używaj globalnego wykluczania plików z tym rozszerzeniem (używając .gitconfigpliku wymienionego gdzie indziej, aby zawsze był ignorowany dla użytkownika).

W ten sposób możesz na przykład:

/projectname/mypasswords.exc 

a jeśli zostałeś wykluczony *.excglobalnie, wiesz, że nie zostanie on popełniony, nawet jeśli zapomnisz indywidualnie wykluczyć ten konkretny plik.