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

docs(updating-datahub) Bump minor version on v0.14.0 notes #11255

Merged
merged 1 commit into from
Sep 10, 2024

Conversation

maggiehays
Copy link
Collaborator

@maggiehays maggiehays commented Aug 27, 2024

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 Tableau ingestion process.
    • Introduced a new parameter --run-id for the put CLI command.
  • Breaking Changes

    • Protobuf CLI behavior modified with a new -protocProp flag.
    • Data flow aspects now produce an additional field.
    • OpenAPI V3 aspect creation requires wrapping within a value key.
    • Global Tags Aspect structure modified to include optional fields.
    • Glue source profiling configuration now requires enabled: true.
  • Deprecations

    • OpenAPI v1 endpoints will be phased out in six months.
  • Documentation

    • Updated versioning and breaking changes in the DataHub documentation.

Copy link
Contributor

coderabbitai bot commented Aug 27, 2024

Walkthrough

The pull request updates the updating-datahub.md documentation to reflect changes in versioning and several breaking changes associated with DataHub. The version number is incremented from 0.14.0 to 0.14.0.2. Key modifications include changes to the Protobuf CLI, additional fields in data flow aspects, adjustments to the OpenAPI V3 aspect structure, and updated profiling configurations. The document also notes the deprecation of OpenAPI v1 endpoints and introduces enhancements to Tableau ingestion and the DatahubClientConfig object.

Changes

File Change Summary
docs/how/updating-datahub.md - Version updated from 0.14.0 to 0.14.0.2
- Protobuf CLI modified with new flag -protocProp
- Data flow info aspect now produces an additional field
- OpenAPI V3 aspect creation requires wrapping within a value key
- Glue source profiling config updated to enabled: true

Possibly related PRs

Suggested labels

merge-pending-ci

Poem

🐇 In the garden where data flows,
A new version blooms and grows.
With flags and fields, we make our way,
Updating paths for a brighter day.
So hop along, let’s celebrate,
DataHub’s changes, oh, how great! 🌼


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@github-actions github-actions bot added the docs Issues and Improvements to docs label Aug 27, 2024
@david-leifker david-leifker merged commit 2a62ba8 into master Sep 10, 2024
27 checks passed
@david-leifker david-leifker deleted the maggiehays-patch-1 branch September 10, 2024 20:46
@maggiehays
Copy link
Collaborator Author

@coderabbitai summary

Copy link
Contributor

coderabbitai bot commented Oct 5, 2024

✅ Actions performed

Summary regeneration triggered.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues and Improvements to docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants