docs: add v2 install banner to dbt-core PyPI description - #16258
Merged
Merged
Conversation
Points users landing on the dbt-core PyPI page to the v2 install docs. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 1.latest #16258 +/- ##
============================================
- Coverage 91.55% 91.51% -0.04%
============================================
Files 223 223
Lines 28346 28346
============================================
- Hits 25951 25940 -11
- Misses 2395 2406 +11
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The new changelog entry sets Issue: "", which will generate a broken empty issue link in the rendered changelog output.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds a short banner at the top of core/README.md (used as the dbt-core PyPI long description) to direct users to dbt v2 installation documentation, and records the update in the changelog system.
Changes:
- Prepends a plain Markdown blockquote “Note” banner to
core/README.mdlinking to the v2 install docs. - Adds a Changie
.changes/unreleasedentry describing the banner addition.
File summaries
| File | Description |
|---|---|
| core/README.md | Adds a top-of-file banner note/link intended to render well on both GitHub and PyPI. |
| .changes/unreleased/Under the Hood-20260909-063207.yaml | Adds a changelog entry for the README/PyPI description update. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
graciegoheen
requested changes
Sep 9, 2026
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
aahel
approved these changes
Sep 10, 2026
This was referenced Sep 14, 2026
itsnamangoyal
added a commit
that referenced
this pull request
Sep 15, 2026
…6299) * docs: add v2 install banner to dbt-core PyPI description Points users landing on the dbt-core PyPI page to the v2 install docs. * docs: expand v2 install banner with dbt-oss distribution details --------- (cherry picked from commit da504cf) Co-authored-by: Tauhid Anjum <tauhidanjum@gmail.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> Co-authored-by: Naman Goyal <43905880+itsnamangoyal@users.noreply.github.com>
itsnamangoyal
added a commit
that referenced
this pull request
Sep 15, 2026
…6300) * docs: add v2 install banner to dbt-core PyPI description Points users landing on the dbt-core PyPI page to the v2 install docs. * docs: expand v2 install banner with dbt-oss distribution details --------- (cherry picked from commit da504cf) Co-authored-by: Tauhid Anjum <tauhidanjum@gmail.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> Co-authored-by: Naman Goyal <43905880+itsnamangoyal@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
core/README.mdpointing users to the v2 install docs, since this README is also rendered as thedbt-corePyPI long description.[!NOTE]alert syntax was avoided since PyPI's renderer (comrak, semantic alert style) doesn't apply GitHub's styling for it — bold text renders consistently on both GitHub and PyPI.Test plan
nightly-release.ymlorrelease.ymldispatch withtest_run: true)🤖 Generated with Claude Code