Update README to include details on upgrading #297
Merged
Conversation
This file contains 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
glsdown
temporarily deployed
to
Approve Integration Tests
GitHub Actions
Inactive
glsdown
temporarily deployed
to
Approve Integration Tests
GitHub Actions
Inactive
glsdown
temporarily deployed
to
Approve Integration Tests
GitHub Actions
Inactive
glsdown
temporarily deployed
to
Approve Integration Tests
GitHub Actions
Inactive
README.md
Outdated
| ``` | ||
| packages: | ||
| - package: brooklyn-data/dbt_artifacts | ||
| version: 2.3.0 | ||
| ``` | ||
|
|
||
| :contruction-worker: Make sure to fix at least the **minor** version, to avoid issues when a new release is open. See the notes on upgrading below for more detail. | ||
|
|
||
| 2. Run `dbt deps` to install the package | ||
|
|
||
| 3. Add an on-run-end hook to your `dbt_project.yml`: `on-run-end: "{{ dbt_artifacts.upload_results(results) }}"` |
There was a problem hiding this comment.
Could we add these examples as yml examples like the others as I think it would make it easier to copy and paste for users
There was a problem hiding this comment.
Good plan - change made.
glsdown
temporarily deployed
to
Approve Integration Tests
GitHub Actions
Inactive
glsdown
temporarily deployed
to
Approve Integration Tests
GitHub Actions
Inactive
glsdown
temporarily deployed
to
Approve Integration Tests
GitHub Actions
Inactive
glsdown
temporarily deployed
to
Approve Integration Tests
GitHub Actions
Inactive
jared-rimmer
approved these changes
Apr 28, 2023
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.
Overview
There were some questions around version numbers and making breaking changes. This introduces instructions to clarify how to handle upgrading the version.
It additionally removes reference to always ensure that the package is included wherever
upload_resultsis used, as this causes concurrency issues as noted in #271.Update type - breaking / non-breaking
What does this solve?
Outstanding questions
N/A
What databases have you tested with?
N/A - no code changes, only documentation