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 --host flag to docs serve #10228

Merged
merged 3 commits into from
May 28, 2024
Merged

add --host flag to docs serve #10228

merged 3 commits into from
May 28, 2024

Conversation

MichelleArk
Copy link
Contributor

@MichelleArk MichelleArk commented May 27, 2024

resolves #10229

Problem

As part of GHSA-pmrx-695r-4349, we explicitly set 127.0.0.1 as the default bind address for dbt docs serve. However, we did not provide the ability for users to be able to override / opt-out of the default, and the change in default caused reported breakages in user deployments (example: #10208 (comment)).

Solution

dbt docs serve binds to '127.0.0.1' by default, but is possible to override via a new --host flag.

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
    🎩
Screenshot 2024-05-28 at 11 07 01 AM Screenshot 2024-05-28 at 11 04 03 AM Screenshot 2024-05-28 at 11 03 33 AM
  • This PR includes tests, or tests are not required/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 May 27, 2024
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 May 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.73%. Comparing base (84456f5) to head (aadf2bd).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10228      +/-   ##
==========================================
- Coverage   88.74%   88.73%   -0.01%     
==========================================
  Files         180      180              
  Lines       22449    22451       +2     
==========================================
  Hits        19923    19923              
- Misses       2526     2528       +2     
Flag Coverage Δ
integration 86.07% <50.00%> (-0.07%) ⬇️
unit 63.38% <100.00%> (+<0.01%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MichelleArk MichelleArk marked this pull request as ready for review May 27, 2024 17:44
@MichelleArk MichelleArk requested a review from a team as a code owner May 27, 2024 17:44
Copy link
Member

@aranke aranke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@MichelleArk MichelleArk merged commit c2d4643 into main May 28, 2024
63 checks passed
@MichelleArk MichelleArk deleted the host-arg-docs-serve branch May 28, 2024 15:11
github-actions bot pushed a commit that referenced this pull request May 28, 2024
github-actions bot pushed a commit that referenced this pull request May 28, 2024
github-actions bot pushed a commit that referenced this pull request May 28, 2024
QMalcolm added a commit that referenced this pull request Jun 5, 2024
* add --host flag to docs serve (#10228)

(cherry picked from commit c2d4643)

* fix test_serve unit test

---------

Co-authored-by: Michelle Ark <[email protected]>
Co-authored-by: Michelle Ark <[email protected]>
Co-authored-by: Quigley Malcolm <[email protected]>
QMalcolm pushed a commit that referenced this pull request Jun 5, 2024
* add --host flag to docs serve (#10228)

(cherry picked from commit c2d4643)

* fix test_serve unit test

---------

Co-authored-by: Michelle Ark <[email protected]>
Co-authored-by: Michelle Ark <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add --host flag to dbt docs serve, defaulting to '127.0.0.1'
2 participants