Skip to content

Commit

Permalink
docs: Add docs for pre-commit setup
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr-Sunglasses authored May 29, 2024
1 parent 0cebb9a commit f4ac5f8
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@ The following services are exposed:
### Secrets Discovery and namespacing

1. For each PR, Sarthi creates a preview environment using the `docker-compose` specified.
2. Sarthi finds the secret for the service as follows.
2. Before Submitting a Pull Request, install pre-commit using `pip3 install pre-commit` and install the pre-commit git hooks: `pre-commit install`.
3. Sarthi finds the secret for the service as follows.
- Check the vault under the `project/feature-branch` namespace and find secrets there.
- There is a default namespace reserved for developers to specify default secrets for all the PS. Secrets defined under `project/default-dev-secrets` are used if `project/feature-branch` secret path is empty.
- If the default namespace is not configured as well, Sarthi automatically tries to find `sample.env`, `env.sample`, `.env.sample` and similar sample env files in the root directory and loads those sample environment variables to both `default-dev-secrets` and `project/feature-branch`
Expand Down

0 comments on commit f4ac5f8

Please sign in to comment.