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

Adding Unit testing docs and reference page #4603

Merged
merged 94 commits into from
Feb 14, 2024
Merged

Conversation

matthewshaver
Copy link
Contributor

@matthewshaver matthewshaver commented Dec 6, 2023

What are you changing in this pull request and why?

Prepping for unit testing with a reference page in the /reference/resource-properties category. This is an early iteration to give guidance to those who will test this feature.

The narrative material and more in depth details of the feature and it's execution will come at a future date.

[Internal] refer to the Notion doc for more information

Checklist

Adding new pages (delete if not applicable):

  • Add page to website/sidebars.js
  • Provide a unique filename for the new page

@matthewshaver matthewshaver requested a review from a team as a code owner December 6, 2023 22:00
Copy link

vercel bot commented Dec 6, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 14, 2024 8:44pm

@github-actions github-actions bot added content Improvements or additions to content size: medium This change will take up to a week to address Docs team Authored by the Docs team @dbt Labs labels Dec 6, 2023
@matthewshaver matthewshaver changed the base branch from current to next December 6, 2023 23:29
@matthewshaver matthewshaver changed the title [DRAFT] Adding Unit testing reference page Adding Unit testing reference page Jan 9, 2024
website/dbt-versions.js Outdated Show resolved Hide resolved

Unit tests validate your modeling logic on a small set of static inputs before you materialize your full model in production. Unit tests enable test-driven development, with benefits for developer efficiency and code reliability.

To run just your unit tests:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To run just your unit tests:
To execute only your unit tests, use the command:

Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

@matthewshaver My minor fixes for the reference page

Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

These changes look good for closed beta from docs POV. Am glad we have a follow-on issue for adding more context and explaining input and format.

@jtcohen6
Copy link
Collaborator

jtcohen6 commented Feb 14, 2024

Thank you @matthewshaver @runleonarun, excited to get these docs live ahead of kicking off closed beta access with a handful of folks today :)

website/docs/docs/build/unit-tests.md Show resolved Hide resolved
website/docs/docs/build/unit-tests.md Show resolved Hide resolved
website/docs/docs/build/unit-tests.md Outdated Show resolved Hide resolved
website/docs/docs/build/unit-tests.md Outdated Show resolved Hide resolved
website/docs/docs/build/unit-tests.md Outdated Show resolved Hide resolved
website/docs/reference/commands/test.md Show resolved Hide resolved
website/docs/docs/build/unit-tests.md Outdated Show resolved Hide resolved
website/docs/docs/build/unit-tests.md Outdated Show resolved Hide resolved
website/docs/docs/build/unit-tests.md Outdated Show resolved Hide resolved
website/docs/docs/build/unit-tests.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@graciegoheen graciegoheen left a comment

Choose a reason for hiding this comment

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

Looks good for now, then we can tackle the fast follow work!

@matthewshaver matthewshaver merged commit 57dc83f into current Feb 14, 2024
7 checks passed
@matthewshaver matthewshaver deleted the unit-testing branch February 14, 2024 21:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs February-2024 size: large This change will more than a week to address and might require more than one person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants