From d1187f9b4de51c16f2c97f4dbde2cd07ecd66747 Mon Sep 17 00:00:00 2001 From: Mike Alfare <13974384+mikealfare@users.noreply.github.com> Date: Thu, 6 Feb 2025 20:08:17 -0500 Subject: [PATCH] Turn off main (#994) * turn off issue creation * disable dependabot * update docs to point users to dbt-adapters * update nightly release test branch * remove main from release branch tests --- .github/ISSUE_TEMPLATE/bug-report.yml | 84 -------------- .github/ISSUE_TEMPLATE/config.yml | 5 +- .github/ISSUE_TEMPLATE/feature-request.yml | 59 ---------- .github/ISSUE_TEMPLATE/regression-report.yml | 82 ------------- .github/dependabot.yml | 29 ----- .github/pull_request_template.md | 34 +----- .github/workflows/nightly-release.yml | 2 +- .github/workflows/release-branch-tests.yml | 1 + CONTRIBUTING.md | 115 +------------------ README.md | 37 +----- 10 files changed, 11 insertions(+), 437 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/regression-report.yml delete mode 100644 .github/dependabot.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml deleted file mode 100644 index dc2cdd8c1..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ /dev/null @@ -1,84 +0,0 @@ -name: 🐞 Bug -description: Report a bug or an issue you've found with dbt-redshift -title: "[Bug] " -labels: ["bug", "triage"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - - type: checkboxes - attributes: - label: Is this a new bug in dbt-redshift? - description: > - In other words, is this an error, flaw, failure or fault in our software? - - If this is a bug that broke existing functionality that used to work, please open a regression issue. - If this is a bug in the dbt-core logic, please open an issue in the dbt-core repository. - If this is a bug experienced while using dbt Cloud, please report to [support](mailto:support@getdbt.com). - If this is a request for help or troubleshooting code in your own dbt project, please join our [dbt Community Slack](https://www.getdbt.com/community/join-the-community/) or open a [Discussion question](https://github.com/dbt-labs/docs.getdbt.com/discussions). - - Please search to see if an issue already exists for the bug you encountered. - options: - - label: I believe this is a new bug in dbt-redshift - required: true - - label: I have searched the existing issues, and I could not find an existing issue for this bug - required: true - - type: textarea - attributes: - label: Current Behavior - description: A concise description of what you're experiencing. - validations: - required: true - - type: textarea - attributes: - label: Expected Behavior - description: A concise description of what you expected to happen. - validations: - required: true - - type: textarea - attributes: - label: Steps To Reproduce - description: Steps to reproduce the behavior. - placeholder: | - 1. In this environment... - 2. With this config... - 3. Run '...' - 4. See error... - validations: - required: true - - type: textarea - id: logs - attributes: - label: Relevant log output - description: | - If applicable, log output to help explain your problem. - render: shell - validations: - required: false - - type: textarea - attributes: - label: Environment - description: | - examples: - - **OS**: Ubuntu 20.04 - - **Python**: 3.9.12 (`python3 --version`) - - **dbt-core**: 1.1.1 (`dbt --version`) - - **dbt-redshift**: 1.1.0 (`dbt --version`) - value: | - - OS: - - Python: - - dbt-core: - - dbt-redshift: - render: markdown - validations: - required: false - - type: textarea - attributes: - label: Additional Context - description: | - Links? References? Anything that will give us more context about the issue you are encountering! - - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a5ce0b8a7..95cfbae5c 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -7,8 +7,11 @@ contact_links: url: mailto:support@getdbt.com about: Are you using dbt Cloud? Contact our support team for help! - name: Participate in Discussions - url: https://github.com/dbt-labs/dbt-redshift/discussions + url: https://github.com/dbt-labs/dbt-adapters/discussions about: Do you have a Big Idea for dbt-redshift? Read open discussions, or start a new one + - name: Create an issue for dbt-redshift + url: https://github.com/dbt-labs/dbt-adapters/issues/new/choose + about: Report a bug or request a feature for dbt-redshift - name: Create an issue for dbt-core url: https://github.com/dbt-labs/dbt-core/issues/new/choose about: Report a bug or request a feature for dbt-core diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml deleted file mode 100644 index 986e101ab..000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ /dev/null @@ -1,59 +0,0 @@ -name: ✨ Feature -description: Propose a straightforward extension of dbt-redshift functionality -title: "[Feature] <title>" -labels: ["enhancement", "triage"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this feature request! - - type: checkboxes - attributes: - label: Is this your first time submitting a feature request? - description: > - We want to make sure that features are distinct and discoverable, - so that other members of the community can find them and offer their thoughts. - - Issues are the right place to request straightforward extensions of existing dbt-redshift functionality. - For "big ideas" about future capabilities of dbt-redshift, we ask that you open a - [discussion](https://github.com/dbt-labs/dbt-redshift/discussions) in the "Ideas" category instead. - options: - - label: I have read the [expectations for open source contributors](https://docs.getdbt.com/docs/contributing/oss-expectations) - required: true - - label: I have searched the existing issues, and I could not find an existing issue for this feature - required: true - - label: I am requesting a straightforward extension of existing dbt-redshift functionality, rather than a Big Idea better suited to a discussion - required: true - - type: textarea - attributes: - label: Describe the feature - description: A clear and concise description of what you want to happen. - validations: - required: true - - type: textarea - attributes: - label: Describe alternatives you've considered - description: | - A clear and concise description of any alternative solutions or features you've considered. - validations: - required: false - - type: textarea - attributes: - label: Who will this benefit? - description: | - What kind of use case will this feature be useful for? Please be specific and provide examples, this will help us prioritize properly. - validations: - required: false - - type: input - attributes: - label: Are you interested in contributing this feature? - description: Let us know if you want to write some code, and how we can help. - validations: - required: false - - type: textarea - attributes: - label: Anything else? - description: | - Links? References? Anything that will give us more context about the feature you are suggesting! - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/regression-report.yml b/.github/ISSUE_TEMPLATE/regression-report.yml deleted file mode 100644 index 6d62e8c09..000000000 --- a/.github/ISSUE_TEMPLATE/regression-report.yml +++ /dev/null @@ -1,82 +0,0 @@ -name: ☣️ Regression -description: Report a regression you've observed in a newer version of dbt-redshift -title: "[Regression] <title>" -labels: ["bug", "regression", "triage"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this regression report! - - type: checkboxes - attributes: - label: Is this a regression in a recent version of dbt-redshift? - description: > - A regression is when documented functionality works as expected in an older version of dbt-redshift, - and no longer works after upgrading to a newer version of dbt-redshift - options: - - label: I believe this is a regression in dbt-redshift functionality - required: true - - label: I have searched the existing issues, and I could not find an existing issue for this regression - required: true - - type: textarea - attributes: - label: Current Behavior - description: A concise description of what you're experiencing. - validations: - required: true - - type: textarea - attributes: - label: Expected/Previous Behavior - description: A concise description of what you expected to happen. - validations: - required: true - - type: textarea - attributes: - label: Steps To Reproduce - description: Steps to reproduce the behavior. - placeholder: | - 1. In this environment... - 2. With this config... - 3. Run '...' - 4. See error... - validations: - required: true - - type: textarea - id: logs - attributes: - label: Relevant log output - description: | - If applicable, log output to help explain your problem. - render: shell - validations: - required: false - - type: textarea - attributes: - label: Environment - description: | - examples: - - **OS**: Ubuntu 20.04 - - **Python**: 3.9.12 (`python3 --version`) - - **dbt-core (working version)**: 1.1.1 (`dbt --version`) - - **dbt-redshift (working version)**: 1.1.0 (`dbt --version`) - - **dbt-core (regression version)**: 1.2.0 (`dbt --version`) - - **dbt-redshift (regression version)**: 1.2.0 (`dbt --version`) - value: | - - OS: - - Python: - - dbt-core (working version): - - dbt-redshift (working version): - - dbt-core (regression version): - - dbt-redshift (regression version): - render: markdown - validations: - required: true - - type: textarea - attributes: - label: Additional Context - description: | - Links? References? Anything that will give us more context about the issue you are encountering! - - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - validations: - required: false diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index 746dcae22..000000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,29 +0,0 @@ -version: 2 -updates: - - package-ecosystem: "pip" - directory: "/" - schedule: - interval: "daily" - rebase-strategy: "disabled" - ignore: - - dependency-name: "*" - update-types: - - version-update:semver-patch - - package-ecosystem: "github-actions" - directory: "/" - schedule: - interval: "weekly" - rebase-strategy: "disabled" - ignore: - - dependency-name: "*" - update-types: - - version-update:semver-patch - - package-ecosystem: "docker" - directory: "/docker" - schedule: - interval: "weekly" - rebase-strategy: "disabled" - ignore: - - dependency-name: "*" - update-types: - - version-update:semver-patch diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a3c340cc3..527ffd366 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,35 +1,3 @@ -resolves # -[docs](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) dbt-labs/docs.getdbt.com/# - <!--- - Include the number of the issue addressed by this PR above if applicable. - PRs for code changes without an associated issue *will not be merged*. - See CONTRIBUTING.md for more information. - - Include the number of the docs issue that was opened for this PR. If - this change has no user-facing implications, "N/A" suffices instead. New - docs tickets can be created by clicking the link above or by going to - https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose. + This repository has moved into [dbt-labs/dbt-adapters](https://www.github.com/dbt-labs/dbt-adapters). --> - -### Problem - -<!--- - Describe the problem this PR is solving. What is the application state - before this PR is merged? ---> - -### Solution - -<!--- - Describe the way this PR solves the above problem. Add as much detail as you - can to help reviewers understand your changes. Include any alternatives and - tradeoffs you considered. ---> - -### Checklist - -- [ ] I have read [the contributing guide](https://github.com/dbt-labs/dbt-core/blob/main/CONTRIBUTING.md) and understand what's expected of me -- [ ] I have run this code in development and it appears to resolve the stated issue -- [ ] This PR includes tests, or tests are not required/relevant for this PR -- [ ] This PR has no interface changes (e.g. macros, cli, logs, json artifacts, config files, adapter interface, etc) or this PR has already received feedback and approval from Product or DX diff --git a/.github/workflows/nightly-release.yml b/.github/workflows/nightly-release.yml index e6366524d..437adeac9 100644 --- a/.github/workflows/nightly-release.yml +++ b/.github/workflows/nightly-release.yml @@ -27,7 +27,7 @@ defaults: shell: bash env: - RELEASE_BRANCH: "1.5.latest" # must test against most recent .latest branch to have parity for dependency with core + RELEASE_BRANCH: "1.9.latest" # must test against most recent .latest branch to have parity for dependency with core jobs: aggregate-release-data: diff --git a/.github/workflows/release-branch-tests.yml b/.github/workflows/release-branch-tests.yml index 004c6fb29..7134d64de 100644 --- a/.github/workflows/release-branch-tests.yml +++ b/.github/workflows/release-branch-tests.yml @@ -28,4 +28,5 @@ jobs: uses: dbt-labs/actions/.github/workflows/release-branch-tests.yml@main with: workflows_to_run: '["main.yml", "integration.yml"]' + include_main: false secrets: inherit diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11a88a1cd..2ab144841 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,115 +1,4 @@ # Contributing to `dbt-redshift` -1. [About this document](#about-this-document) -3. [Getting the code](#getting-the-code) -5. [Running `dbt-redshift` in development](#running-dbt-redshift-in-development) -6. [Testing](#testing) -7. [Updating Docs](#updating-docs) -7. [Submitting a Pull Request](#submitting-a-pull-request) - -## About this document -This document is a guide intended for folks interested in contributing to `dbt-redshift`. Below, we document the process by which members of the community should create issues and submit pull requests (PRs) in this repository. It is not intended as a guide for using `dbt-redshift`, and it assumes a certain level of familiarity with Python concepts such as virtualenvs, `pip`, python modules, filesystems, and so on. This guide assumes you are using macOS or Linux and are comfortable with the command line. - -For those wishing to contribute we highly suggest reading the [dbt-core](https://github.com/dbt-labs/dbt-core/blob/main/CONTRIBUTING.md), if you haven't already. Almost all of the information there is applicable to contributing here, too! - -### Signing the CLA - -Please note that all contributors to `dbt-redshift` must sign the [Contributor License Agreement](https://docs.getdbt.com/docs/contributor-license-agreements) to have their Pull Request merged into an `dbt-redshift` codebase. If you are unable to sign the CLA, then the `dbt-redshift` maintainers will unfortunately be unable to merge your Pull Request. You are, however, welcome to open issues and comment on existing ones. - - -## Getting the code - -You will need `git` in order to download and modify the `dbt-redshift` source code. You can find direction [here](https://github.com/git-guides/install-git) on how to install `git`. - -### External contributors - -If you are not a member of the `dbt-labs` GitHub organization, you can contribute to `dbt-redshift` by forking the `dbt-redshift` repository. For a detailed overview on forking, check out the [GitHub docs on forking](https://help.github.com/en/articles/fork-a-repo). In short, you will need to: - -1. fork the `dbt-redshift` repository -2. clone your fork locally -3. check out a new branch for your proposed changes -4. push changes to your fork -5. open a pull request against `dbt-labs/dbt-redshift` from your forked repository - -### dbt Labs contributors - -If you are a member of the `dbt Labs` GitHub organization, you will have push access to the `dbt-redshift` repo. Rather than forking `dbt-redshift` to make your changes, just clone the repository, check out a new branch, and push directly to that branch. - - -## Running `dbt-redshift` in development - -### Installation - -First make sure that you set up your `virtualenv` as described in [Setting up an environment](https://github.com/dbt-labs/dbt-core/blob/HEAD/CONTRIBUTING.md#setting-up-an-environment). Ensure you have the latest version of pip installed with `pip install --upgrade pip`. Next, install `dbt-redshift` latest dependencies: - -```sh -pip install -e . -r ./dev-requirements.txt -``` - -When `dbt-redshift` is installed this way, any changes you make to the `dbt-redshift` source code will be reflected immediately in your next `dbt run` command that uses `dbt-redshift`. - -To confirm you have correct `dbt-core` and adapter versions installed please run `dbt --version` and `which dbt` to check the correct executable path you wish to use for `dbt-core` is in your current virtualenv. - - -## Testing - -### Initial Setup - -`dbt-redshift` contains [unit](https://github.com/dbt-labs/dbt-redshift/tree/main/tests/unit) and [functional](https://github.com/dbt-labs/dbt-redshift/tree/main/tests/functional) tests. Functional tests require testing against an actual Redshift warehouse. We have CI set up to test against a Redshift warehouse during PR checks. - -In order to run functional tests locally, you will need a `test.env` file in the root of the repository that contains credentials for your Redshift warehouse. - -Note: This `test.env` file is git-ignored, but please be extra careful to never check in credentials or other sensitive information when developing. To create your `test.env` file, copy the provided example file, then supply your relevant credentials. - -``` -cp test.env.example test.env -$EDITOR test.env -``` - -### Test commands -There are a few methods for running tests locally. - -#### `tox` -`tox` takes care of managing Python virtualenvs and installing dependencies in order to run tests. You can also run tests in parallel. For example, you can run unit tests for Python 3.9 and Python 3.10, and `flake8` checks in parallel with `tox -p`. Also, you can run unit tests for specific python versions with `tox -e py39`. The configuration of these tests are located in `tox.ini`. - -#### `pytest` -Finally, you can also run a specific test or group of tests using `pytest` directly. With a Python virtualenv active and dev dependencies installed you can do things like: - -```sh -# run specific redshift functional tests -python -m pytest tests/functional/adapter/concurrent_transactions -# run specific redshift functional tests in a file -python -m pytest tests/functional/adapter/test_basic.py -# run all unit tests in a file -python -m pytest tests/unit/test_redshift_adapter.py -# run a specific unit test -python -m pytest tests/unit/test_redshift_adapter.py::TestRedshiftAdapterConversions::test_convert_date_type -``` - -## Updating Docs - -Many changes will require an update to the `dbt-redshift` docs. If so, here are some useful resources to find where the current behavior is documented. - -- Docs are [here](https://docs.getdbt.com/). -- The docs repo for making changes is located [here]( https://github.com/dbt-labs/docs.getdbt.com). -- The changes made are likely to impact one or both of [Redshift Profile](https://docs.getdbt.com/reference/warehouse-profiles/redshift-profile), or [Redshift Configs](https://docs.getdbt.com/reference/resource-configs/redshift-configs). -- We ask every community member who makes a user-facing change to open an issue or PR regarding doc changes. - -## Adding CHANGELOG Entry - -We use [changie](https://changie.dev) to generate `CHANGELOG` entries. **Note:** Do not edit the `CHANGELOG.md` directly. Your modifications will be lost. - -Follow the steps to [install `changie`](https://changie.dev/guide/installation/) for your system. - -Once changie is installed and your PR is created, simply run `changie new` and changie will walk you through the process of creating a changelog entry. Commit the file that's created and your changelog entry is complete! - -You don't need to worry about which `dbt-redshift` version your change will go into. Just create the changelog entry with `changie`, and open your PR against the `main` branch. All merged changes will be included in the next minor version of `dbt-redshift`. The Core maintainers _may_ choose to "backport" specific changes in order to patch older minor versions. In that case, a maintainer will take care of that backport after merging your PR, before releasing the new version of `dbt-redshift`. - - -## Submitting a Pull Request - -dbt Labs provides a CI environment to test changes to the `dbt-redshift` adapter and periodic checks against the development version of `dbt-core` through Github Actions. - -A `dbt-redshift` maintainer will review your PR. They may suggest code revision for style or clarity, or request that you add unit or functional test(s). These are good things! We believe that, with a little bit of help, anyone can contribute high-quality code. - -Once all tests are passing and your PR has been approved, a `dbt-redshift` maintainer will merge your changes into the active development branch. And that's it! Happy developing :tada: +This repository has moved into [dbt-labs/dbt-adapters](https://www.github.com/dbt-labs/dbt-adapters). +Please refer to that repo for a guide on how to contribute to `dbt-redshift`. diff --git a/README.md b/README.md index e405aa190..079191120 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,6 @@ <p align="center"> <img src="https://raw.githubusercontent.com/dbt-labs/dbt/ec7dee39f793aa4f7dd3dae37282cc87664813e4/etc/dbt-logo-full.svg" alt="dbt logo" width="500"/> </p> -<p align="center"> - <a href="https://github.com/dbt-labs/dbt-redshift/actions/workflows/main.yml"> - <img src="https://github.com/dbt-labs/dbt-redshift/actions/workflows/main.yml/badge.svg?event=push" alt="Unit Tests Badge"/> - </a> - <a href="https://github.com/dbt-labs/dbt-redshift/actions/workflows/integration.yml"> - <img src="https://github.com/dbt-labs/dbt-redshift/actions/workflows/integration.yml/badge.svg?event=push" alt="Integration Tests Badge"/> - </a> -</p> - -**[dbt](https://www.getdbt.com/)** enables data analysts and engineers to transform their data using the same practices that software engineers use to build applications. - -dbt is the T in ELT. Organize, cleanse, denormalize, filter, rename, and pre-aggregate the raw data in your warehouse so that it's ready for analysis. - -## dbt-redshift - -The `dbt-redshift` package contains all of the code enabling dbt to work with Amazon Redshift. For -more information on using dbt with Redshift, consult [the docs](https://docs.getdbt.com/docs/profile-redshift). - -## Getting started - -- [Install dbt](https://docs.getdbt.com/docs/installation) -- Read the [introduction](https://docs.getdbt.com/docs/introduction/) and [viewpoint](https://docs.getdbt.com/docs/about/viewpoint/) - -## Join the dbt Community - -- Be part of the conversation in the [dbt Community Slack](http://community.getdbt.com/) -- Read more on the [dbt Community Discourse](https://discourse.getdbt.com) - -## Reporting bugs and contributing code - -- Want to report a bug or request a feature? Let us know on [Slack](http://community.getdbt.com/), or open [an issue](https://github.com/dbt-labs/dbt-redshift/issues/new) -- Want to help us build dbt? Check out the [Contributing Guide](https://github.com/dbt-labs/dbt/blob/HEAD/CONTRIBUTING.md) - -## Code of Conduct -Everyone interacting in the dbt project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [dbt Code of Conduct](https://community.getdbt.com/code-of-conduct). +This repository has moved into [dbt-labs/dbt-adapters](https://www.github.com/dbt-labs/dbt-adapters). +Please refer to that repo for information about `dbt-redshift`.