Merge pull request #257 from genlayerlabs/chore/nod-189-ci-automate-changelog

chore(workflows): Simplify sync-docs-from-node workflow

Author: dohernandez

.github/scripts/sanitize-config.py

@@ -7,25 +7,39 @@
 """
 
 import sys
-import yaml
+import re
 
 
 def sanitize_config(config_file_path):
-    """Remove node.dev and node.admin sections from config file."""
+    """Remove node.dev and node.admin sections from config file using regex."""
+    print(f"Sanitizing config file: {config_file_path}")
+    
     # Read the YAML file
     with open(config_file_path, 'r') as f:
-        config = yaml.safe_load(f)
+        content = f.read()
+    
+    print(f"Original file size: {len(content)} bytes")
 
-    # Remove node.dev and node.admin if they exist
-    if 'node' in config:
-        if 'dev' in config['node']:
-            del config['node']['dev']
-        if 'admin' in config['node']:
-            del config['node']['admin']
+    # Remove node.admin section
+    # This regex matches the admin: line and all indented content that follows
+    admin_pattern = r'(\n\s+admin:\s*\n(?:\s+(?:port:\s*\d+|\S.*)\s*\n)*)'
+    if re.search(admin_pattern, content):
+        content = re.sub(admin_pattern, '\n', content)
+        print("Removed node.admin section")
 
-    # Write back to file preserving the structure
+    # Remove node.dev section
+    # This regex matches the dev: line and all indented content that follows
+    dev_pattern = r'(\n\s+dev:\s*\n(?:\s+\S.*\s*\n)*)'
+    if re.search(dev_pattern, content):
+        content = re.sub(dev_pattern, '\n', content)
+        print("Removed node.dev section")
+    
+    # Write back to file
     with open(config_file_path, 'w') as f:
-        yaml.dump(config, f, default_flow_style=False, sort_keys=False, allow_unicode=True)
+        f.write(content)
+    
+    print(f"Sanitized file size: {len(content)} bytes")
+    print("Config sanitization completed")
 
 
 def main():

.github/workflows/README.md

@@ -45,8 +45,8 @@ Add this to a workflow in the genlayer-node repository:
       {
         "source_branch": "${{ github.ref_name }}",
         "changelog_path": "docs/changelog",
-        "api_gen_path": "docs/api/rpc/gen",
-        "api_debug_path": "docs/api/rpc/debug",
+        "api_gen_path": "docs/api/rpc",
+        "api_debug_path": "docs/api/rpc",
         "api_gen_regex": "gen_(?!dbg_).*",
         "api_debug_regex": "gen_dbg_.*"
       }
@@ -81,8 +81,8 @@ From the Actions tab:
 3. Specify parameters:
    - Tag for branch naming (required, e.g., v0.3.5)
    - Source branch (optional, default: main)
-   - API gen path (optional, default: `docs/api/rpc/gen`)
-   - API debug path (optional, default: `docs/api/rpc/debug`)
+   - API gen path (optional, default: `docs/api/rpc`)
+   - API debug path (optional, default: `docs/api/rpc`)
    - API gen regex filter (optional, default: `gen_(?!dbg_).*`)
    - API debug regex filter (optional, default: `gen_dbg_.*`)
 
@@ -114,8 +114,8 @@ The source paths and filters can be customized in the event payload:
 
 #### Paths
 - `changelog_path`: Path to changelog files (default: `docs/changelog`)
-- `api_gen_path`: Path to API gen methods (default: `docs/api/rpc/gen`)
-- `api_debug_path`: Path to API debug methods (default: `docs/api/rpc/debug`)
+- `api_gen_path`: Path to API gen methods (default: `docs/api/rpc`)
+- `api_debug_path`: Path to API debug methods (default: `docs/api/rpc`)
 
 #### Regex Filters
 - `api_gen_regex`: Regex pattern to filter gen API files (default: `gen_(?!dbg_).*`)

.github/workflows/example-trigger-from-node.yml.example

@@ -22,16 +22,16 @@ jobs:
         with:
           fetch-depth: 0  # Fetch all history for tags
 
-      - name: Get latest tag
-        id: get_tag
+      - name: Get version
+        id: get_version
         run: |
-          # Get the latest tag
-          LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
-          if [ -z "$LATEST_TAG" ]; then
+          # Get the latest tag as the version
+          VERSION=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
+          if [ -z "$VERSION" ]; then
             # Fallback to commit SHA if no tags found
-            LATEST_TAG="commit-$(git rev-parse --short HEAD)"
+            VERSION="commit-$(git rev-parse --short HEAD)"
           fi
-          echo "tag=$LATEST_TAG" >> $GITHUB_OUTPUT
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
 
       - name: Trigger documentation sync
         uses: peter-evans/repository-dispatch@v2
@@ -43,11 +43,10 @@ jobs:
           event-type: sync-docs
           client-payload: |
             {
-              "source_branch": "${{ github.ref_name }}",
-              "tag": "${{ steps.get_tag.outputs.tag }}",
+              "version": "${{ steps.get_version.outputs.version }}",
               "changelog_path": "docs/changelog",
-              "api_gen_path": "docs/api/rpc/gen",
-              "api_debug_path": "docs/api/rpc/debug",
+              "api_gen_path": "docs/api/rpc",
+              "api_debug_path": "docs/api/rpc",
               "api_gen_regex": "gen_(?!dbg_).*",
               "api_debug_regex": "gen_dbg_.*"
             }
@@ -56,5 +55,4 @@ jobs:
         run: |
           echo "✅ Triggered documentation sync" >> $GITHUB_STEP_SUMMARY
           echo "- Target repository: genlayerlabs/genlayer-docs" >> $GITHUB_STEP_SUMMARY
-          echo "- Source branch: ${{ github.ref_name }}" >> $GITHUB_STEP_SUMMARY
-          echo "- Tag: ${{ steps.get_tag.outputs.tag }}" >> $GITHUB_STEP_SUMMARY
+          echo "- Version: ${{ steps.get_version.outputs.version }}" >> $GITHUB_STEP_SUMMARY