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

Add doc_blocks to manifest for nodes and columns #11224

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Conversation

aranke
Copy link
Member

@aranke aranke commented Jan 21, 2025

Resolves #11000
Resolves #11001

Problem

doc_blocks are not listed for node/column descriptions, so it's not possible to know if a description was created via literal or via doc block.

Solution

Add a new field doc_blocks for node and column descriptions that is present in the manifest.

doc_blocks is a list of unique IDs that can be accessed like so:

for uid in doc_blocks:
   doc_block = manifest.docs[uid]

I'll also update schemas.getdbt.com once this PR is approved to fix schema check errors below.

Checklist

  • I have read the contributing guide and understand what's expected of me.
  • I have run this code in development, and it appears to resolve the stated issue.
  • This PR includes tests, or tests are not required or relevant for this PR.
  • This PR has no interface changes (e.g., macros, CLI, logs, JSON artifacts, config files, adapter interface, etc.) or this PR has already received feedback and approval from Product or DX.
  • This PR includes type annotations for new and modified functions.

@cla-bot cla-bot bot added the cla:yes label Jan 21, 2025
Copy link
Contributor

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

Copy link

codecov bot commented Jan 21, 2025

Codecov Report

Attention: Patch coverage is 91.42857% with 3 lines in your changes missing coverage. Please review.

Project coverage is 88.87%. Comparing base (31881d2) to head (da9763f).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11224      +/-   ##
==========================================
- Coverage   88.92%   88.87%   -0.05%     
==========================================
  Files         187      187              
  Lines       24049    24072      +23     
==========================================
+ Hits        21386    21395       +9     
- Misses       2663     2677      +14     
Flag Coverage Δ
integration 86.19% <91.42%> (-0.13%) ⬇️
unit 62.44% <17.14%> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
Unit Tests 62.44% <17.14%> (-0.04%) ⬇️
Integration Tests 86.19% <91.42%> (-0.13%) ⬇️

@aranke aranke changed the title "Fix #11000 #11001: Add doc_blocks to manifest for nodes and columns Add doc_blocks to manifest for nodes and columns Jan 22, 2025
@aranke aranke added the artifact_minor_upgrade To bypass the CI check by confirming that the change is not breaking label Jan 22, 2025
@aranke aranke requested a review from wpowers-dbt January 22, 2025 17:31
@aranke aranke marked this pull request as ready for review January 22, 2025 17:32
@aranke aranke requested a review from a team as a code owner January 22, 2025 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
artifact_minor_upgrade To bypass the CI check by confirming that the change is not breaking cla:yes
Projects
None yet
1 participant