Instructions how to install pre-releases

[dbeatty10]

Contributions

• I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

Updates could possible go on this page: https://docs.getdbt.com/dbt-cli/install/pip

I would love to see two things:

1. Instructions to create a python virtual environment #2143
   • Would be nice is this was a stand-alone page
2. Instructions to install pre-releases of dbt adapters
   • Could be stand-alone or an independent section within https://docs.getdbt.com/dbt-cli/install/pip

To install pre-releases for bigquery, databricks, and snowflake all at the same time within zsh, it would look like this:

python3 -m pip install --pre dbt-core dbt-bigquery dbt-databricks dbt-snowflake

But of course we actually want to do this within a virtual environment, like so 😉

dbt --version
python3 -m venv venv
source venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install --pre dbt-core dbt-bigquery dbt-databricks dbt-snowflake
source venv/bin/activate
dbt --version

Ideally, we'd provide different instructions based on the users's operating system and shell, like this:

POSIX bash/zsh

dbt --version
python3 -m venv venv
source venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install --pre dbt-core dbt-bigquery dbt-databricks dbt-snowflake
source venv/bin/activate
dbt --version

POSIX fish

python3 -m venv venv
source venv/bin/activate.fish
python3 -m pip install --upgrade pip
python3 -m pip install --pre dbt-core dbt-bigquery dbt-databricks dbt-snowflake
source venv/bin/activate.fish

POSIX csh/tcsh

python3 -m venv venv
source venv/bin/activate.csh
python3 -m pip install --upgrade pip
python3 -m pip install --pre dbt-core dbt-bigquery dbt-databricks dbt-snowflake
source venv/bin/activate.csh

POSIX PowerShell Core

python3 -m venv venv
venv/bin/Activate.ps1
python3 -m pip install --upgrade pip
python3 -m pip install --pre dbt-core dbt-bigquery dbt-databricks dbt-snowflake
venv/bin/Activate.ps1

Windows cmd.exe

python -m venv venv
venv\Scripts\activate.bat
python -m pip install --upgrade pip
python -m pip install --pre dbt-core dbt-bigquery dbt-databricks dbt-snowflake
venv\Scripts\activate.bat

Windows PowerShell

python -m venv venv
venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install --pre dbt-core dbt-bigquery dbt-databricks dbt-snowflake
venv\Scripts\Activate.ps1

What part(s) of the page would you like to see updated?

Use cases

This gives users clear instructions that they can copy-paste to use beta releases or release candidates.

Expected outcome

User has dbt installed in an isolated environment that doesn't affect the rest of their system. Easy to deactivate and not use if it contains bugs.

Example before vs. after

Before:

After:

Additional information

No response

[runleonarun]

@dbeatty10 I am closing this because the install has changed and this is really old. Let me know if you prefer either:

• Add the icebox label to deal with it and some later time when our queue is smaller, or
• Leave it open in hopes it can get addressed

[dbeatty10]

Thanks for following-up on this @runleonarun !

I think it would still be helpful to provide instructions how to install pre-releases. Maybe we want to do that through dbt-core-bundles?

How would you feel about re-opening this with the icebox label?

[mirnawong1]

thanks @dbeatty10 , happy to take this soon but wanted to double check if this was still the case given the recent 1.8 core + adapter installation update. it looks like this matches (e.g. pip install dbt-core dbt-snowflake) though but triple checking!

[dbeatty10]

Yep, I think these commands will work for v1.8+ 👍 But let me know if not and I will be happy to help troubleshoot.

Note: for folks upgrading from <= v1.7 to >=v1.8, they may need to do something like this also.

[nataliefiann]

Hiya @dbeatty10

I just wanted to double check with the workaround mentioned on your ticket, will users on 1.7 need to upgrade to 1.8 for a pre-release or do they need to use the workaround you mentioned in your ticket?

Kind Regards
Natalie

[dbeatty10]

I just wanted to double check with the workaround mentioned on your ticket, will users on 1.7 need to upgrade to 1.8 for a pre-release or do they need to use the workaround you mentioned in your ticket?

The workaround mentioned here may be necessary when upgrading directly from a version less than v1.8 to v1.8 or above.

If installing a pre-release into a fresh virtual environment that doesn't already have dbt installed, it won't be needed.