Skip to content

Enhance documentation for pre-commit hook setup and performance #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anandgupta42 merged 1 commit into from
Aug 22, 2025
Merged

Enhance documentation for pre-commit hook setup and performance #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion docs/performance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,29 @@
===============================
Performance of Pre-commit Hook
Pre-commit Hook
===============================

Overview
--------
You can use the pre-commit hook to run DataPilot checks on your dbt project. Do this by following the instructions below:

1. Install pre-commit (https://pre-commit.com/#install)
2. Create a file in the root of the project ``.pre-commit-config.yaml``
3. Add to that file this below:
4. Run ``pre-commit run --all-files`` to test it out

.. code-block:: yaml

repos:
- repo: https://github.com/AltimateAI/datapilot-cli
rev: v0.0.27
hooks:
- id: datapilot_run_dbt_checks
args: [--config-name, "[The Config Name in the SaaS UI]", --token, "[YOUR API KEY]", --instance-name, "[Your tenant name]"]


Performance
-----------

The primary objective is to ensure the pre-commit hook operates swiftly and efficiently, preventing any delay in the development workflow. To achieve this, various optimizations have been applied, focusing on minimizing the time and resources required during execution.

Optimizations
Expand Down