Dateien in Git Umbenennen

Warum Dateien umbenennen?

Das Umbenennen von Dateien ist eine gängige Praxis in der Softwareentwicklung aus verschiedenen Gründen:

• Verbesserte Übersichtlichkeit: Das Umbenennen von Dateien kann die Struktur eines Projekts klarer machen und erleichtert es Mitarbeitenden, den Zweck jeder Datei zu verstehen;
• Konsistenz: Die Einhaltung konsistenter Namenskonventionen im gesamten Projekt ist entscheidend für Lesbarkeit und Wartbarkeit;
• Funktionsänderungen: Mit der Weiterentwicklung eines Projekts kann sich die Funktionalität bestimmter Dateien ändern. Das Umbenennen zur Anpassung an diese Änderungen ist wichtig für eine korrekte Dokumentation.

Git-Befehl zum Umbenennen von Dateien

Git vereinfacht das Umbenennen von Dateien. Es ist wichtig, Git-Befehle zu verwenden, um sicherzustellen, dass der Versionsverlauf erhalten bleibt. Der Hauptbefehl zum Umbenennen von Dateien lautet:

git mv old_filename new_filename

Dabei ist old_filename der aktuelle Name der Datei und new_filename der gewünschte neue Name. Dieser Befehl führt drei Aktionen gleichzeitig aus:

• Benennt die Datei lokal um;
• Stellt die Änderung für den Commit bereit;
• Ändert die Datei im Arbeitsverzeichnis.

Nach Ausführung dieses Befehls können die Änderungen committed werden.

Beispielszenario

Zuerst eine Konfigurationsdatei mit dem Namen cg.txt erstellen, die eine einzelne Zeile mit einem Beispielwert für den geheimen Schlüssel enthält:

echo "SECRET_KEY=1234" > cg.txt

Nun den Status des Arbeitsverzeichnisses und des Staging-Bereichs überprüfen:

git status

Diese Datei zum Staging-Bereich hinzufügen:

git add cg.txt

Anschließend diese Hinzufügung committen:

git commit -m "Add config file" 

Der Commit ist erfolgreich, aber der Name der Konfigurationsdatei ist nicht sehr eindeutig. Daher umbenennen in config.txt:

git mv cg.txt config.txt

Erneut den Status des Working Tree und des Staging-Bereichs überprüfen:

git status

Wie Sie sehen können, zeigt der Status an, dass die Datei von cg.txt zu config.txt umbenannt wurde und diese Änderung bereits zum Commit vorgemerkt ist.

Nun diesen Änderung committen:

git commit -m "Rename config file"

Die Konfigurationsdatei wurde erfolgreich umbenannt und der Commit wurde erfolgreich abgeschlossen.