refactor: prepare-audit writes $db.json to the current directory#5
Merged
Conversation
End users `uv tool install` `odoo-db` and invoke it from anywhere on their machine — not from the source tree. The previous hardcoded `audits/` directory polluted whatever working directory the user ran the tool from, and the tracked `audits/.gitkeep` had no purpose outside this repo. - Default output is now `<db>.json` in the current working directory (still overridable via `--output-file`). - Removed `audits/.gitkeep` and the `audits/*.json` ignore rule. - `.gitignore` now ignores `/*.json` at the repo root so local audit dumps stay untracked when running prepare-audit from the source tree during development. - Docstring, README, and AGENTS.md updated to match. Addresses review feedback on #4.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses review feedback on #4 (thread):
audits/.gitkeepwas meaningless outside this repo.audits/subfolder polluted whatever cwd the user ranodoo-dbfrom.Changes
prepare-auditis now<db>.jsonin the current working directory (still overridable via--output-file).audits/.gitkeepand theaudits/*.jsongitignore rule./*.jsonto.gitignoreso local audit dumps stay untracked when running from the source tree during development.Test plan
make check(lint + format + type-check)make test(4 passed)/tmp:odoo-db prepare-audit mydbwrote/tmp/mydb.json(not/tmp/audits/mydb.json).