Update pre-commit hook configuration to version v0.0.27 and enhance documentation

- Updated the pre-commit hook version to v0.0.27 in configuration files.
- Added new optional arguments for manifest and catalog file paths in the README and documentation.
- Clarified requirements for DBT artifacts in the documentation to improve user guidance.

Author: gaurpulkit

.pre-commit-hooks.yaml

@@ -11,3 +11,6 @@
   # --instance-name: Tenant/instance name
   # --backend-url: Backend URL (defaults to https://api.myaltimate.com)
   # --config-name: Name of config to use from API
+  # --manifest-path: Path to DBT manifest file (defaults to ./target/manifest.json)
+  # --catalog-path: Path to DBT catalog file (defaults to ./target/catalog.json)
+  # --base-path: Base path of the dbt project (defaults to current directory)

README.md

@@ -57,13 +57,15 @@ pip install pre-commit
 ```yaml
 repos:
   - repo: https://github.com/AltimateAI/datapilot-cli
-    rev: v0.0.23  # Always use a specific version tag
+    rev: v0.0.27  # Always use a specific version tag
     hooks:
       - id: datapilot_run_dbt_checks
         args: [
           "--config-path", "./datapilot-config.yaml",
           "--token", "${DATAPILOT_TOKEN}",
-          "--instance-name", "${DATAPILOT_INSTANCE}"
+          "--instance-name", "${DATAPILOT_INSTANCE}",
+          "--manifest-path", "./target/manifest.json",
+          "--catalog-path", "./target/catalog.json"
         ]
 ```
 

docs/hooks.rst

@@ -21,7 +21,7 @@ To use the DataPilot pre-commit hook, follow these steps:
 
     repos:
       - repo: https://github.com/AltimateAI/datapilot-cli
-        rev: v0.0.23  # Use a specific version tag, not 'main'
+        rev: v0.0.27  # Use a specific version tag, not 'main'
         hooks:
           - id: datapilot_run_dbt_checks
             args: [
@@ -37,7 +37,7 @@ The DataPilot pre-commit hook supports several configuration options:
 
 **Required Configuration:**
 
-- ``rev``: Always use a specific version tag (e.g., ``v0.0.23``) instead of ``main`` for production stability
+- ``rev``: Always use a specific version tag (e.g., ``v0.0.27``) instead of ``main`` for production stability
 
 **Optional Arguments:**
 
@@ -47,6 +47,8 @@ The DataPilot pre-commit hook supports several configuration options:
 - ``--backend-url``: Backend URL (defaults to https://api.myaltimate.com)
 - ``--config-name``: Name of config to use from API
 - ``--base-path``: Base path of the dbt project (defaults to current directory)
+- ``--manifest-path``: Path to the DBT manifest file (defaults to {base_path}/target/manifest.json)
+- ``--catalog-path``: Path to the DBT catalog file (defaults to {base_path}/target/catalog.json)
 
 **Environment Variables:**
 
@@ -56,13 +58,15 @@ You can use environment variables for sensitive information:
 
     repos:
       - repo: https://github.com/AltimateAI/datapilot-cli
-        rev: v0.0.23
+        rev: v0.0.27
         hooks:
           - id: datapilot_run_dbt_checks
             args: [
               "--config-path", "./datapilot-config.yaml",
               "--token", "${DATAPILOT_TOKEN}",
-              "--instance-name", "${DATAPILOT_INSTANCE}"
+              "--instance-name", "${DATAPILOT_INSTANCE}",
+              "--manifest-path", "./target/manifest.json",
+              "--catalog-path", "./target/catalog.json"
             ]
 
 **Configuration File Example:**
@@ -94,8 +98,18 @@ Once the hook is installed, it will run automatically before each commit. The ho
 
 1. **Validate Configuration**: Check that your config file exists and is valid
 2. **Authenticate**: Use your provided token and instance name to authenticate
-3. **Analyze Changes**: Only analyze files that have changed in the commit
-4. **Report Issues**: Display any issues found and prevent the commit if problems are detected
+3. **Load DBT Artifacts**: Load manifest and catalog files for analysis
+4. **Analyze Changes**: Only analyze files that have changed in the commit
+5. **Report Issues**: Display any issues found and prevent the commit if problems are detected
+
+**Required DBT Artifacts:**
+
+The pre-commit hook requires DBT manifest and catalog files to function properly:
+
+- **Manifest File**: Generated by running `dbt compile` or `dbt run`. Default location: `./target/manifest.json`
+- **Catalog File**: Generated by running `dbt docs generate`. Default location: `./target/catalog.json`
+
+**Note**: The catalog file is optional but recommended for comprehensive analysis. If not available, the hook will continue without catalog information.
 
 **Manual Execution:**
 
@@ -115,6 +129,8 @@ To run individual hooks:
 
 - **Authentication Issues**: Ensure your token and instance name are correctly set
 - **Empty Config Files**: The hook will fail if your config file is empty or invalid
+- **Missing Manifest File**: Ensure you have run `dbt compile` or `dbt run` to generate the manifest.json file
+- **Missing Catalog File**: Run `dbt docs generate` to create the catalog.json file (optional but recommended)
 - **No Changes**: If no relevant files have changed, the hook will skip execution
 - **Network Issues**: Ensure you have access to the DataPilot API
 
@@ -150,13 +166,15 @@ Here's a complete example of a ``.pre-commit-config.yaml`` file:
           - id: black
 
       - repo: https://github.com/AltimateAI/datapilot-cli
-        rev: v0.0.23
+        rev: v0.0.27
         hooks:
           - id: datapilot_run_dbt_checks
             args: [
               "--config-path", "./datapilot-config.yaml",
               "--token", "${DATAPILOT_TOKEN}",
-              "--instance-name", "${DATAPILOT_INSTANCE}"
+              "--instance-name", "${DATAPILOT_INSTANCE}",
+              "--manifest-path", "./target/manifest.json",
+              "--catalog-path", "./target/catalog.json"
             ]
 
 Feedback and Contributions