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 version.md #4427

Merged
merged 4 commits into from
Nov 10, 2023
Merged

Update version.md #4427

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
83f417a
Update version.md
mirnawong1 Nov 9, 2023
8008a99
Merge branch 'current' into mirnawong1-patch-21
mirnawong1 Nov 10, 2023
3c01cbe
Update version.md
mirnawong1 Nov 10, 2023
406fc5d
Update version.md
mirnawong1 Nov 10, 2023
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
49 changes: 9 additions & 40 deletions website/docs/reference/project-configs/version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@ import VersionsCallout from '/snippets/_version-callout.md';

<VersionsCallout />

<VersionBlock firstVersion="1.5">

dbt projects have two distinct types of the `version` tags. This field has a different meaning depending on its location.
dbt projects have two distinct types of `version` tags. This field has a different meaning depending on its location.

## `dbt_project.yml` versions

The version tag in a `dbt_project` file represents the version of your dbt project. Starting in version 1.5, `version` in the `dbt_project.yml` is an *optional parameter*. If specified, the version must be in a [semantic version](https://semver.org/) format, e.g. `1.0.0`. The default value if not specified is `None`.
The version tag in a `dbt_project` file represents the version of your dbt project.

Starting in dbt version 1.5, `version` in the `dbt_project.yml` is an *optional parameter*. If used, the version must be in a [semantic version](https://semver.org/) format, such as `1.0.0`. The default value is `None` if not specified. For users on dbt version 1.4 or lower, this tag is required, though it isn't currently used meaningfully by dbt.

For more on Core versions, see [About dbt Core versions](/docs/dbt-versions/core).

<File name='dbt_project.yml'>

```yml
Expand All @@ -29,9 +31,9 @@ version: version

A version tag in a `.yml` property file provides the control tag, which informs how dbt processes property files.

Starting from version 1.5, dbt will no longer require this configuration in your resource `.yml` files. If you want to know more about why this tag was previously required, you can refer to the [property file FAQs](reference/configs-and-properties#faqs).
Starting from version 1.5, dbt will no longer require this configuration in your resource `.yml` files. If you want to know more about why this tag was previously required, you can refer to the [FAQs](#faqs). For users on dbt version 1.4 or lower, this tag is required,

For more on property files, see their general [documentation](reference/configs-and-properties#where-can-i-define-properties) on the same page.
For more on property files, see their general [documentation](/reference/configs-and-properties#where-can-i-define-properties) on the same page.

<Tabs
groupId="resource-version-configs"
Expand Down Expand Up @@ -72,39 +74,6 @@ models:

</Tabs>

## FAQS

</VersionBlock>

<VersionBlock lastVersion="1.4">

dbt projects have two distinct types of `version` tags. This field has a different meaning depending on its location.

## `dbt_project.yml` versions

The version tag in a `dbt_project` file represents the version of your dbt project and **is a required parameter**. However, it isn't currently used in a meaningful way by dbt. The version must follow a [semantic version](https://semver.org/) format, such as 1.0.0. For more information about dbt Core versions, refer to [About dbt Core versions](/docs/dbt-versions/core).
<File name='dbt_project.yml'>

```yml
version: version
```

</File>

## `.yml` property file versions

A version tag in a `.yml` property file provides the control tag, which informs how dbt processes property files. For more on why we require this tag, see property file [FAQs](reference/configs-and-properties#faqs).

For more on property files, see their general [documentation](reference/configs-and-properties#where-can-i-define-properties) on the same page.

<File name='<any valid filename>.yml'>

```yml
version: 2 # Only 2 is accepted by current and recent versions of dbt.

models:
...
```

</File>

</VersionBlock>
<FAQ path="Project/why-version-2" />
Loading