Skip to content
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.

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

Generate docs for only the staged/changed model(s) #196

Open
astro30 opened this issue Mar 12, 2024 · 3 comments
Open

Generate docs for only the staged/changed model(s) #196

astro30 opened this issue Mar 12, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@astro30
Copy link

astro30 commented Mar 12, 2024

Describe the feature you'd like
Be able to generate documentation only for the staged model(s).

Additional context
On big code bases, dbt docs generate could be extremely long (several minutes). When you have to run a particular hook, let's say check-model-has-all-columns, you have to execute dbt run and dbt docs generate before (it is a prerequisite). So, we can imagine to succession of hooks:

- repo: https://github.com/dbt-checkpoint/dbt-checkpoint
  rev: v1.2.0
  hooks:
    - id: dbt-run
    - id: dbt-docs-generate
    - id: check-model-has-all-columns

dbt-run will default to run only changed files. But dbt-docs-generate will not, that is why, I want to add this feature. This will streamline "doc-related" hooks for big codebases.

@astro30 astro30 added the enhancement New feature or request label Mar 12, 2024
@pgoslatara
Copy link
Contributor

@astro30 Feel free to add this feature!

@astro30
Copy link
Author

astro30 commented Apr 12, 2024

Working on it ;)

@astro30
Copy link
Author

astro30 commented Apr 12, 2024

I have suggested a PR here -> #210

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants