Compile assets as part of docs generate #2623

clrcrl · 2020-07-13T13:16:42Z

resolves #2072

Description

When a user runs dbt docs generate, any files in their assets directory (configurable!) will be compiled to the target/assets directory — useful for adding images to documentation

Extra validation

I added an image to my own project, at assets/dbt-logo.png, and then added it as a description:

version: 2

models:
  - name: customers
    description: "![dbt Logo](assets/dbt-logo.png)"

It totally works 😎

Checklist

I have signed the CLA
I have run this code in development and it appears to resolve the stated issue
This PR includes tests, or tests are not required/relevant for this PR
I have updated the CHANGELOG.md and added information about my change to the "dbt next" section.

beckjake · 2020-07-13T14:33:47Z

Is having this as part of docs generate a reasonable solution?

Sure, I don't see why not.

Should I have a test that checks for the presence of a compiled file? If so, can you point me to any other tests that assert that a file exists?

Yeah. Check out the 040_init_test integration tests.

test/unit/test_config.py

clrcrl · 2020-07-21T16:55:48Z

core/dbt/config/project.py

@@ -401,6 +402,7 @@ def from_project_config(
        )

        docs_paths: List[str] = value_or(cfg.docs_paths, all_source_paths)
+        asset_paths: List[str] = value_or(cfg.asset_paths, ['assets'])


heads up, this differs from the original ticket that had the default as ['static'], but I prefer the consistency

beckjake

This looks good to me, great tests!

The only question I have is: should this default to ['assets'], or to []? Maybe you should have to opt-in to have dbt copy your files around? @jtcohen6 I guess this question is for you

clrcrl · 2020-07-21T17:23:15Z

CHANGELOG.md

@@ -9,6 +9,7 @@
 - Add more helpful error message for misconfiguration in profiles.yml ([#2569](https://github.com/fishtown-analytics/dbt/issues/2569), [#2627](https://github.com/fishtown-analytics/dbt/pull/2627))
 ### Fixes
 - Adapter plugins can once again override plugins defined in core ([#2548](https://github.com/fishtown-analytics/dbt/issues/2548), [#2590](https://github.com/fishtown-analytics/dbt/pull/2590))
+- Compile assets as part of docs generate ([#2072](https://github.com/fishtown-analytics/dbt/issues/2072), [#2623](https://github.com/fishtown-analytics/dbt/pull/2623/files#))


I'll fix this lol

Suggested change

- Compile assets as part of docs generate ([#2072](https://github.com/fishtown-analytics/dbt/issues/2072), [#2623](https://github.com/fishtown-analytics/dbt/pull/2623/files#))

- Compile assets as part of docs generate ([#2072](https://github.com/fishtown-analytics/dbt/issues/2072), [#2623](https://github.com/fishtown-analytics/dbt/pull/2623))

clrcrl · 2020-07-21T17:23:50Z

Also @drewbanin — can you add your comments re: whether this should work in dbt Cloud?

jtcohen6 · 2020-07-21T19:36:44Z

The only question I have is: should this default to ['assets'], or to []? Maybe you should have to opt-in to have dbt copy your files around? @jtcohen6 I guess this question is for you

Great point, I think this should be opt-in. The majority of users shouldn't need to worry about an assets folder (or even know such a thing exists) until they need it and read the docs about it, at which point adding an extra config line to dbt_project.yml feels appropriate. I'd hate to have someone accidentally add an entirely unrelated root-level directory named assets and be surprised.

clrcrl · 2020-07-21T19:47:49Z

I was going to argue the counter point — every thing else has a default directory, so we should be consistent here.

But, turns out that analyses don't have a default directory! TIL!

clrcrl · 2020-07-23T18:34:18Z

@drewbanin — assigning you since you have context about the potential security implications of this PR

clrcrl · 2020-07-28T19:49:46Z

Just rebased and pushed :)

cla-bot bot added the cla:yes label Jul 13, 2020

clrcrl force-pushed the asset-paths branch from 17acc68 to c758a4c Compare July 13, 2020 13:17

clrcrl requested a review from beckjake July 13, 2020 13:30

beckjake reviewed Jul 13, 2020

View reviewed changes

test/unit/test_config.py Outdated Show resolved Hide resolved

clrcrl force-pushed the asset-paths branch 2 times, most recently from f5065fd to 6e4e9db Compare July 21, 2020 14:51

clrcrl commented Jul 21, 2020

View reviewed changes

clrcrl changed the title ~~WIP: Compile assets as part of docs generate~~ Compile assets as part of docs generate Jul 21, 2020

clrcrl marked this pull request as ready for review July 21, 2020 17:10

clrcrl requested a review from beckjake July 21, 2020 17:10

beckjake approved these changes Jul 21, 2020

View reviewed changes

clrcrl commented Jul 21, 2020

View reviewed changes

clrcrl requested a review from drewbanin July 23, 2020 18:34

clrcrl removed the request for review from drewbanin July 28, 2020 19:44

Compile assets as part of docs generate

a3a1b14

clrcrl force-pushed the asset-paths branch from a4ac245 to a3a1b14 Compare July 28, 2020 19:49

clrcrl merged commit c9eb3c2 into dev/marian-anderson Jul 28, 2020

clrcrl deleted the asset-paths branch July 28, 2020 21:15

clrcrl mentioned this pull request Jul 30, 2020

Write docs on asset-paths dbt-labs/docs.getdbt.com#315

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Compile assets as part of docs generate #2623

Compile assets as part of docs generate #2623

clrcrl commented Jul 13, 2020 •

edited

Loading

beckjake commented Jul 13, 2020

clrcrl Jul 21, 2020

beckjake left a comment

clrcrl Jul 21, 2020

clrcrl commented Jul 21, 2020

jtcohen6 commented Jul 21, 2020

clrcrl commented Jul 21, 2020 •

edited

Loading

clrcrl commented Jul 23, 2020

clrcrl commented Jul 28, 2020

	- Compile assets as part of docs generate ([#2072](https://github.com/fishtown-analytics/dbt/issues/2072), [#2623](https://github.com/fishtown-analytics/dbt/pull/2623/files#))
	- Compile assets as part of docs generate ([#2072](https://github.com/fishtown-analytics/dbt/issues/2072), [#2623](https://github.com/fishtown-analytics/dbt/pull/2623))

Compile assets as part of docs generate #2623

Compile assets as part of docs generate #2623

Conversation

clrcrl commented Jul 13, 2020 • edited Loading

Description

Extra validation

Checklist

beckjake commented Jul 13, 2020

clrcrl Jul 21, 2020

Choose a reason for hiding this comment

beckjake left a comment

Choose a reason for hiding this comment

clrcrl Jul 21, 2020

Choose a reason for hiding this comment

clrcrl commented Jul 21, 2020

jtcohen6 commented Jul 21, 2020

clrcrl commented Jul 21, 2020 • edited Loading

clrcrl commented Jul 23, 2020

clrcrl commented Jul 28, 2020

clrcrl commented Jul 13, 2020 •

edited

Loading

clrcrl commented Jul 21, 2020 •

edited

Loading