-
Notifications
You must be signed in to change notification settings - Fork 2.1k
docs: fill four gaps found in a customer-facing feature sweep #11565
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
Open
keydunov
wants to merge
1
commit into
master
Choose a base branch
from
claude/gallant-ramanujan-i839zy
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -404,6 +404,20 @@ deployment is shown in the dbt settings card, ready to drop into a CI step. | |
| /> | ||
| </Frame> | ||
|
|
||
| The trigger call accepts an optional `ref` — a branch or tag in your dbt repository — | ||
| to sync from for that call only, without changing the branch saved on the | ||
| integration. Use it in a pull request pipeline to test the ref under review before it | ||
| merges. | ||
|
|
||
| The response includes a `syncJobId`, which a pipeline can use to wait on the sync | ||
| instead of firing the trigger and moving on blind: | ||
|
|
||
| | Call | What it does | | ||
| | --- | --- | | ||
| | `GET .../dbt-sync/{syncJobId}` | Returns the sync's current `status`. Poll it until `status` reaches `COMPLETED` or `FAILED`. | | ||
| | `GET .../dbt-sync/{syncJobId}/result` | Once `status` is `COMPLETED`, returns the generated cube files and cube count. | | ||
| | `DELETE .../dbt-sync/{syncJobId}` | Cancels a sync that's still running — for example, when a newer push supersedes it. | | ||
|
Comment on lines
+415
to
+419
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Two small things in this table:
|
||
|
|
||
| ### Trigger on every push | ||
|
|
||
| Register a webhook on your dbt repository so Cube syncs automatically whenever the | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
refparameter is described but not shown — a reader can't act on this without knowing where it goes (query string vs. JSON body) and what the trigger's HTTP method is. Neither is stated anywhere on the page, and the screenshot above only shows the URL.Worth one short concrete line, e.g.
POST .../dbt-sync?ref=my-branchor a{"ref": "my-branch"}body — whichever matches the implementation.Fix this →