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

[CT-2727] [Bug] dbt docs serve edits the manifest.json #7922

Closed
2 tasks done
Nisond opened this issue Jun 22, 2023 · 3 comments · Fixed by #7554
Closed
2 tasks done

[CT-2727] [Bug] dbt docs serve edits the manifest.json #7922

Nisond opened this issue Jun 22, 2023 · 3 comments · Fixed by #7554
Labels
bug Something isn't working

Comments

@Nisond
Copy link

Nisond commented Jun 22, 2023

Is this a new bug in dbt-core?

  • I believe this is a new bug in dbt-core
  • I have searched the existing issues, and I could not find an existing issue for this bug

Current Behavior

When I run dbt docs serve --port 8000 it edits the manifest.json, the index.html, and the partial_parse.msgpack in the target folder.

I have verified that this edit happens by looking at the last modified timestamp on the file as well as by manually making edits to the json which then are reverted upon running docs serve.

Expected Behavior

dbt docs serve --port 8000 to not edit any files in the target folder

Steps To Reproduce

Unclear if other are able to replicate this. I'm using dbt-core=1.5.0 and dbt-bigquery=1.5.0 on linux.

These are steps I can take to replicate

  1. opened a terminal
  2. activate the virtual environment I use for dbt, containing dbt-core and dbt-bigquery
  3. used cd to navigate to the dbt project folder
  4. ran ‘dbt docs serve --port 8000’

I have a single terminal open on the local machine and am not hosting documentation. I have tried restarting the machine first.

Relevant log output

N/A

Environment

- OS: Debian 4.19.0-24-cloud-amd64
- Python: 3.7.12
- dbt:1.5.0

Which database adapter are you using with dbt?

bigquery

Additional Context

See here for original issue and discussion.

@Nisond Nisond added bug Something isn't working triage labels Jun 22, 2023
@github-actions github-actions bot changed the title [Bug] dbt docs serve edits the manifest.json [CT-2727] [Bug] dbt docs serve edits the manifest.json Jun 22, 2023
@dbeatty10 dbeatty10 self-assigned this Jun 22, 2023
@dbeatty10
Copy link
Contributor

Thank you for opening this issue @Nisond !

I read through the discussion in Discourse that you linked -- thank you for including that helpful context. 🧠

It sounds like your concrete goal in this instance is to do post-processing of manifest.json and add hyperlinks to model descriptions. While trying to accomplish that, it sounds like you were surprised that dbt docs serve doesn't just use the manifest.json as-is.

Follow-up questions

Could you give an example of a model description that you'd be adding a hyperlink to?

Also, what would be the barriers to adding those hyperlinks to the descriptions directly like below?

Before

models/_models.yml

models:
  - name: legendary_creatures
    description: This description doesn't have any hyperlinks

After

models/_models.yml

models:
  - name: legendary_creatures
    description: >
      [`Legendary_creatures`](https://en.wikipedia.org/wiki/Category:Legendary_creatures) is a category on Wikipedia.
      [Deadpool](https://en.wikipedia.org/wiki/Deadpool) was listed in the top-10 as-of 2023-06-22 ([ref](https://en.wikipedia.org/wiki/Wikipedia:Popular_pages#Legendary_Creatures)).

@dbeatty10 dbeatty10 removed their assignment Jun 22, 2023
@joellabes
Copy link
Contributor

I think this might be resolved by #7554?

@dbeatty10
Copy link
Contributor

@Nisond we believe this was resolved by #7554 and available in dbt-core 1.5.1 and onwards.

Could you give that a shot and let us know if you run into any problems?

@dbeatty10 dbeatty10 removed the triage label Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants