bug/persist-docs

[fivetran-catfritz]

PR Overview

This PR will address the following Issue/Feature: #3

This PR will result in the following new package version:

• v0.1.1
• Documentation update only

Please provide the finalized CHANGELOG entry which details the relevant changes included in this PR:

Bug fix

• Shortened the documentation description for field distribution_status, so no character limit error is generated when persisting docs.

PR Checklist

Basic Validation

Please acknowledge that you have successfully performed the following commands locally:

• dbt run –full-refresh && dbt test
• dbt run (if incremental models are present)

Before marking this PR as "ready for review" the following have been applied:

• The appropriate issue has been linked, tagged, and properly assigned
• All necessary documentation and version upgrades have been applied
• docs were regenerated (unless this PR does not include any code or yml updates)
• BuildKite integration tests are passing
• Detailed validation steps have been provided below

Detailed Validation

Please share any and all of your validation steps:

• Was able to re-create the original issue by:
  • using seed data
  • using the below settings in my dbt_project.yml in bigquery:

models:
  +persist_docs:
    relation: true
    columns: true

which resulted in error:

22:24:09  Completed with 1 error and 0 warnings:
22:24:09  
22:24:09    400 PATCH https://bigquery.googleapis.com/bigquery/v2/projects/dbt-package-testing/datasets/zz_dbt_catherine_qualtrics_prod/tables/stg_qualtrics__distribution_contact?prettyPrint=false: The description for field status is too long. The maximum length is 1024 characters.
22:24:09  

• The updates in this PR resolved the issue.

[fivetran-joemarkiewicz]

@fivetran-catfritz this looks great! I have one suggestion to update the integration_tests/dbt_project.yml to test the persisting of docs. Once that is applied this is read for release review.

[fivetran-joemarkiewicz]

Why don't we also persist the docs in the integration tests to confirm that this works as expected across all other warehouses as well.

[fivetran-catfritz]

@fivetran-joemarkiewicz Good idea! I have added, and it passed integrations tests. One caveat--I had to turn off the persist_docs: columns for databricks to get it to pass. This is not us since I'm seeing there are known issues on dbt's end with persist_docs for databricks.

[fivetran-reneeli]

Looks good