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.

Sign up for GitHub

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

Update run.md to document new dbt run options --use-colors and --no-use-colors #286

Merged
merged 3 commits into from
Aug 19, 2020
Merged

Update run.md to document new dbt run options --use-colors and --no-use-colors #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
23b1604
Update run.md
rsenseman Jul 14, 2020
5f624d4
Merge branch 'next' into patch-1
rsenseman Aug 19, 2020
20b410e
add line to changed documentation page
rsenseman Aug 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions website/docs/docs/guides/migration-guide/upgrading-to-0-18-0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,5 @@ Please be aware of the following changes in v0.18.0. While breaking, we do not e
- [`asset-paths` config](asset-paths) (also updated [dbt_project.yml](dbt_project.yml.md) and the [description](description) docs to match)
- [`impersonate_service_account` in the BigQuery profile configuration](https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#service-account-impersonation)
- [adapter.dispatch](adapter#dispatch)
- [Enable or Disable colorized logs](run#enable-or-disable-colorized-logs)
- [deferring to previous run state](run#deferring-to-previous-run-state)
15 changes: 15 additions & 0 deletions website/docs/reference/commands/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,21 @@ FailFast Error in model model_1 (models/model_1.sql)
Failing early due to test failure or runtime error
```

## Enable or Disable Colorized Logs

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you add a changelog note here:

<Changelog>New in v0.18.0</Changelog>

<Changelog>

- The `--use-colors` and `--no-use-colors` flags are new in dbt v0.18.0

</Changelog>

DBT can colorize the run logs output to your terminal to make the logs more readable. This is enabled by default, [can be overriden in your profiles.yml] (https://docs.getdbt.com/reference/profiles.yml/#use_colors), and both the default and the profiles.yml can be overriden at the command line. Use `--use-colors` or `--no-use-colors` to enable or disable log colorizing from the command line.
Example usage:
```
$ dbt --use-colors run
$ dbt --no-use-colors run
```

## Deferring to previous run state

<Changelog>
Expand Down