Git Haken, um das Vorhandensein von Code zu überprüfen

Question

Ich habe begrenzte Kenntnisse in git, um die Dokumentation zu git-hooks zu verstehen. Ich wollte wissen, ob es eine Möglichkeit gibt, ein git-hook oder ein anderes Konstrukt hinzuzufügen, so dass es überprüfen kann, ob Code in einer der Dateien vorhanden/auskommentiert ist. Mein Workflow ist, dass ich eine Konfigurationsdatei globalConfig.js habe, die zwei Satzkonfigurationen development und production enthält. Wenn ich mich entwickle, entziehe ich die development Konfiguration auskommentieren und production Konfiguration auskommentieren, aber wenn ich Code zu meinem Repo festlege, möchte ich sicherstellen, dass die production Konfiguration unkommentiert ist und development Konfiguration kommentiert ist.

Auszug aus globalConfig.js Datei

Entwicklung

// Production config - Always uncomment it before commiting 
    // const firebaseConfig = { 
    // apiKey: "prod", 
    // authDomain: "prod", 
    // databaseURL: "prod", 
    // storageBucket: "prod", 
    // messagingSenderId: "prod" 
    // }; 

    // Dev config - Always comment out before commiting 
    const firebaseConfig = { 
    apiKey: "dev", 
    authDomain: "dev", 
    databaseURL: "dev", 
    storageBucket: "dev", 
    messagingSenderId: "dev" 
    }; 

Produktion

// Production config - Always uncomment it before commiting 
    const firebaseConfig = { 
    apiKey: "prod", 
    authDomain: "prod", 
    databaseURL: "prod", 
    storageBucket: "prod", 
    messagingSenderId: "prod" 
    }; 

    // Dev config - Always comment out before commiting 
    // const firebaseConfig = { 
    // apiKey: "dev", 
    // authDomain: "dev", 
    // databaseURL: "dev", 
    // storageBucket: "dev", 
    // messagingSenderId: "dev" 
    //}; 

Ist es möglich, sie über git-hook oder einem anderen git construc zu erreichen t?

Answer 1

Der folgende Pre-Commit-Hook sollte Ihnen den Einstieg erleichtern. Wenn eine Datei das Wort development enthält, muss es ein Kommentar sein, ansonsten ist das Commit nicht erlaubt.

Schritte:

1. erstellen .git/hooks/pre-commit mit folgendem Inhalt:

    git diff --cached --name-status | while read file; 
    do 
       if egrep "development" $file ; then 
        echo "ERROR: Disallowed development configuration in file: ${file}" 
        exit 1 
       fi 
    done || exit $? 

Beachten Sie, dass die egrep Ausdruck sehr einfach atm ist, aber man sollte es ändern können, entsprechend Ihren Anforderungen (dh der genaue Inhalt von globalConfig.js) ODER, können Sie Ihre Fragen mit Schnipsel von globalConfig.js aktualisieren :)

1. Berechtigungen ändern

chmod 755 .git/hooks/pre-commit

3. Und dann versuchen, eine ungültige globalConfig.js Datei zu begehen. Hier ist, was mein Test zeigte:

☻ cat globalConfig.js         SomeOtherFeature/abc 0d174e2 ✗ 
//Configuration 
var Production = new String("Production Configuration"); 
var development = new String("development Configuration"); 

$ git add globalConfig.js 

$ git commit -m "Commit should not be allowed" 
Checking if globalConfig.js is valid 
var development = new String("development Configuration"); 
ERROR: Disallowed development configuration in file: globalConfig.js