docs(ingest/dbt): update run result paths examples

[acrylJonny]

Checklist

• The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• Links to related issues (if applicable)
• Tests for the changes have been added/updated (if applicable)
• Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

• New Features

  • Updated the configuration for handling dbt test result paths, allowing users to specify multiple paths with the new run_results_paths parameter.

• Documentation

  • Refined documentation to clarify the changes in configuration structure and to illustrate the usage of the new parameter format.

• Bug Fixes

  • Improved handling of test result paths in the testing framework, enhancing flexibility for users managing dbt test results across multiple files.

[coderabbitai]

Walkthrough

The recent changes enhance the flexibility of the dbt integration by renaming the test_results_path parameter to run_results_paths and modifying its structure from a single string to a list. This update allows users to specify multiple paths for run results, improving the management of dbt test outputs. The documentation and tests have been updated accordingly to reflect this shift, ensuring clarity and supporting more versatile configurations.

Changes

Files	Change Summary
.../dbt/dbt.md, .../dbt/dbt_recipe.yml, .../dbt/test_dbt.py	Renamed test_results_path to run_results_paths, changing its structure from a single string to a list to support multiple paths for run results. Updated documentation and tests to align with these changes.

Poem

In the meadow where bunnies play,
New paths for results brighten the day.
With hops and skips, we celebrate,
Flexibility now makes us great!
Let the data flow, a joyful dance,
In our dbt world, take a chance! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

metadata-ingestion/docs/sources/dbt/dbt_recipe.yml (1)

9-10: Clarify the comment for run_results_paths.

The comment indicates that the path is optional for recording dbt test results, but now that it's a list, consider clarifying whether all paths are optional or if at least one is required.

    run_results_paths:
      - "${DBT_PROJECT_ROOT}/target/run_results.json" # optional for recording dbt test results; specify multiple paths if needed

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 080f2a2 and f4671f3.

Files selected for processing (3)

• metadata-ingestion/docs/sources/dbt/dbt.md (3 hunks)
• metadata-ingestion/docs/sources/dbt/dbt_recipe.yml (1 hunks)
• metadata-ingestion/tests/integration/dbt/test_dbt.py (3 hunks)

Additional comments not posted (6)

metadata-ingestion/docs/sources/dbt/dbt.md (3)

174-174: Ensure consistency in parameter updates.

The documentation correctly reflects the changes from test_results_path to run_results_paths. Ensure all instances of the old parameter are updated throughout the document to maintain consistency.

---

218-219: Confirm the example configuration reflects the new parameter.

The example configuration now uses run_results_paths. Ensure that users are aware of the new list format and that existing configurations are updated accordingly.

---

233-234: Verify all configuration examples are updated.

The configuration examples have been updated to use run_results_paths. Double-check that all examples throughout the documentation reflect this change to prevent user confusion.

metadata-ingestion/tests/integration/dbt/test_dbt.py (3)

449-455: Ensure comprehensive testing for run_results_paths.

The test function now uses run_results_paths. Verify that the tests adequately cover the functionality of handling multiple paths.

---

342-348: Verify test coverage for multiple paths.

The run_results_paths parameter is now a list. Ensure that the tests cover scenarios with multiple paths to validate the new functionality.

---

529-535: Confirm multiple path handling in tests.

The run_results_paths parameter is used in this test. Double-check that the tests cover scenarios involving multiple paths to ensure robustness.