Skip to content

Commit a397398

Browse files
Enhance documentation for pre-commit hook setup and performance (#68)
- Added detailed instructions for setting up the pre-commit hook to run DataPilot checks on dbt projects. - Included a sample configuration for the `.pre-commit-config.yaml` file. - Expanded the performance section to emphasize the importance of efficiency in the pre-commit hook's operation.
1 parent 0f92e1a commit a397398

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/performance.rst

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,29 @@
11
===============================
2-
Performance of Pre-commit Hook
2+
Pre-commit Hook
33
===============================
44

55
Overview
66
--------
7+
You can use the pre-commit hook to run DataPilot checks on your dbt project. Do this by following the instructions below:
8+
9+
1. Install pre-commit (https://pre-commit.com/#install)
10+
2. Create a file in the root of the project ``.pre-commit-config.yaml``
11+
3. Add to that file this below:
12+
4. Run ``pre-commit run --all-files`` to test it out
13+
14+
.. code-block:: yaml
15+
16+
repos:
17+
- repo: https://github.com/AltimateAI/datapilot-cli
18+
rev: v0.0.27
19+
hooks:
20+
- id: datapilot_run_dbt_checks
21+
args: [--config-name, "[The Config Name in the SaaS UI]", --token, "[YOUR API KEY]", --instance-name, "[Your tenant name]"]
22+
23+
24+
Performance
25+
-----------
26+
727
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.
828

929
Optimizations

0 commit comments

Comments
 (0)