We're going to always have some differences we want to ignore

Author: EdGeraghty

.github/workflows/headscale-config-checker.yml

@@ -28,17 +28,31 @@ jobs:
       - name: Check for new options
         id: check
         run: |
-          # Extract just the key structure, ignoring values
+          # Extract structure with better handling of commented lines
           extract_structure() {
-            grep -E "^[[:space:]]*[^#].*:" "$1" | \
+            # Use a more explicit approach
+            grep -v "^[[:space:]]*#" "$1" | \
+            grep -E "^[[:space:]]*[^[:space:]]*:" | \
+            grep -v "# DIFF_IGNORE" | \
             sed 's/:[[:space:]]*.*$//' | \
+            sed 's/^[[:space:]]*//' | \
             sort -u
           }
           
+          echo "Processing local config..."
           extract_structure "templates/headscale.template.yaml" > local-structure.txt
+          
+          echo "Processing upstream config..."
           extract_structure "upstream-config.yaml" > upstream-structure.txt
           
-          # Find truly missing keys
+          echo "Local keys found (first 10):"
+          head -10 local-structure.txt
+          echo ""
+          echo "Upstream keys found (first 10):"
+          head -10 upstream-structure.txt
+          echo ""
+          
+          # Find missing keys
           comm -23 upstream-structure.txt local-structure.txt > new-options.txt
           
           if [ -s new-options.txt ]; then
@@ -62,5 +76,5 @@ jobs:
               owner: context.repo.owner,
               repo: context.repo.repo,
               issue_number: context.issue.number,
-              body: `## 🆕 New Headscale Config Options\n\n\`\`\`diff\n${newOptions}\`\`\``
+              body: `## 🆕 New Headscale Config Options\n\n\`\`\`diff\n${newOptions.split('\n').map(line => line.trim() ? `+ ${line}` : '').filter(line => line).join('\n')}\`\`\``
             });

templates/headscale.template.yaml

@@ -144,6 +144,8 @@ database:
   # Enable debug mode. This setting requires the log.level to be set to "debug" or "trace".
   debug: false
 
+  path: false  # DIFF_IGNORE
+
   # GORM configuration settings.
   gorm:
     # Enable prepared statements.
@@ -197,27 +199,27 @@ database:
 # TLS for a domain with Let's Encrypt.
 #
 # URL to ACME directory
-#acme_url: https://acme-v02.api.letsencrypt.org/directory
+#acme_url: https://acme-v02.api.letsencrypt.org/directory # DIFF_IGNORE
 
 # Email to register with ACME provider
-#acme_email: ""
+#acme_email: "" # DIFF_IGNORE
 
 # Domain name to request a TLS certificate for:
-#tls_letsencrypt_hostname: ""
+#tls_letsencrypt_hostname: "" # DIFF_IGNORE
 
 # Path to store certificates and metadata needed by
 # letsencrypt
 # For production:
-#tls_letsencrypt_cache_dir: /var/lib/headscale/cache
+#tls_letsencrypt_cache_dir: /var/lib/headscale/cache # DIFF_IGNORE
 
 # Type of ACME challenge to use, currently supported types:
 # HTTP-01 or TLS-ALPN-01
 # See: docs/ref/tls.md for more information
-#tls_letsencrypt_challenge_type: HTTP-01
+#tls_letsencrypt_challenge_type: HTTP-01 # DIFF_IGNORE
 # When HTTP-01 challenge is chosen, letsencrypt must set up a
 # verification endpoint, and it will be listening on:
 # :http = port 80
-#tls_letsencrypt_listen: ":http"
+#tls_letsencrypt_listen: ":http" # DIFF_IGNORE
 
 ## Use already defined certificates:
 tls_cert_path: ""