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

Add CI workflow #15

Merged
merged 5 commits into from
Jan 8, 2024
Merged

Add CI workflow #15

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
705375e
setup
emmyoop Jan 5, 2024
f26075c
first pass at stubbing out workflows
emmyoop Jan 5, 2024
014730c
update build workflow
emmyoop Jan 6, 2024
6d91ff5
fix regex
emmyoop Jan 6, 2024
c6a4f10
add grep to build
emmyoop Jan 8, 2024
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
89 changes: 89 additions & 0 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# **what?**
# Verifies python build on all code commited to the repository. This workflow
# should not require any secrets since it runs for PRs from forked repos. By
# default, secrets are not passed to workflows running from a forked repos.

# **why?**
# Ensure code for dbt meets a certain quality standard.

# **when?**
# This will run for all PRs, when code is pushed to main, and when manually triggered.

name: "Build"

on:
push:
branches:
- "main"
pull_request:
workflow_dispatch:

permissions: read-all

# will cancel previous workflows triggered by the same event and for the same ref for PRs or same SHA otherwise
concurrency:
group: ${{ github.workflow }}-${{ github.event_name }}-${{ contains(github.event_name, 'pull_request') && github.event.pull_request.head.ref || github.sha }}
cancel-in-progress: true

defaults:
run:
shell: bash

jobs:
build:
# TODO: blocked on https://github.com/dbt-labs/dbt-adapter/issues/3
name: build packages

runs-on: ubuntu-latest

steps:
- name: Check out the repository
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'

- name: "Install build specific python dependencies"
run: |
python -m pip install --user --upgrade pip
python -m pip install --upgrade wheel twine check-wheel-contents
python -m pip --version

- name: "Install Hatch"
shell: bash
run: pip3 install hatch

- name: "Build Python Package"
run: |
hatch build

- name: "Show distributions"
run: ls -lh dist/

- name: "Check distribution descriptions"
run: |
twine check dist/*

- name: "Check wheel contents"
run: |
check-wheel-contents dist/*.whl --ignore W007,W008

- name: "Install wheel distributions"
run: |
find ./dist/dbt_common-*.whl -maxdepth 1 -type f | xargs python -m pip install --force-reinstall --find-links=dist/

# TODO: how to validate here? we did dbt --version previously...
- name: "Check wheel distributions"
run: |
pip freeze
Copy link
Collaborator

Choose a reason for hiding this comment

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

perhaps: pip freeze | grep dbt-common? it should return a non-zero exit code if no match is found. e.g.

❯ pip freeze | grep requests
❯ echo $?
1
❯ pip freeze | grep dbt-common
dbt-common @ file:///Users/michelleark/src/dbt-common
❯ echo $?
0


- name: "Install source distributions"
run: |
find ./dist/dbt_common-*.gz -maxdepth 1 -type f | xargs python -m pip install --force-reinstall --find-links=dist/

# TODO: how to validate here? we did dbt --version previously...
- name: "Check source distributions"
run: |
pip freeze
53 changes: 53 additions & 0 deletions .github/workflows/ci_code_quality.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# **what?**
# Runs code quality checks on all code commited to the repository. This workflow
# should not require any secrets since it runs for PRs from forked repos. By
# default, secrets are not passed to workflows running from a forked repos.

# **why?**
# Ensure code for dbt meets a certain quality standard.

# **when?**
# This will run for all PRs, when code is pushed to main, and when manually triggered.

name: "Check Code Quality"

on:
push:
branches:
- "main"
pull_request:
workflow_dispatch:

permissions: read-all

# will cancel previous workflows triggered by the same event and for the same ref for PRs or same SHA otherwise
concurrency:
group: ${{ github.workflow }}-${{ github.event_name }}-${{ contains(github.event_name, 'pull_request') && github.event.pull_request.head.ref || github.sha }}
cancel-in-progress: true

defaults:
run:
shell: bash

jobs:
code-quality:
name: code-quality

runs-on: ubuntu-latest
timeout-minutes: 10

steps:
- name: Check out the repository
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'

- name: Install Hatch
shell: bash
run: pip3 install hatch

- name: Run Pre-commit Hooks
run: hatch run dev-env:pre-commit run --show-diff-on-failure --color=always --all-files
73 changes: 73 additions & 0 deletions .github/workflows/ci_tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# **what?**
# Runs unit tests on all code commited to the repository. This workflow
# should not require any secrets since it runs for PRs from forked repos. By
# default, secrets are not passed to workflows running from a forked repos.

# **why?**
# Ensure code for dbt meets a certain quality standard.

# **when?**
# This will run for all PRs, when code is pushed to main, and when manually triggered.

name: Unit Tests

on:
push:
branches:
- "main"
pull_request:
workflow_dispatch:

permissions: read-all

# will cancel previous workflows triggered by the same event and for the same ref for PRs or same SHA otherwise
concurrency:
group: ${{ github.workflow }}-${{ github.event_name }}-${{ contains(github.event_name, 'pull_request') && github.event.pull_request.head.ref || github.sha }}
cancel-in-progress: true

defaults:
run:
shell: bash

jobs:
unit:
name: "Run tests / python ${{ matrix.python-version }}"

runs-on: ubuntu-latest
timeout-minutes: 10

strategy:
fail-fast: false
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11"]

steps:
- name: "Check out the repository"
uses: actions/checkout@v3

- name: "Set up Python ${{ matrix.python-version }}"
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}

- name: "Install Hatch"
shell: bash
run: pip3 install hatch

- name: "Run Tests"
run: hatch run dev-env:pytest tests

- name: "Get current date"
if: always()
id: date
run: |
CURRENT_DATE=$(date +'%Y-%m-%dT%H_%M_%S') # no colons allowed for artifacts
echo "date=$CURRENT_DATE" >> $GITHUB_OUTPUT

# TODO: what setup is needed here?
# - name: Upload Unit Test Coverage to Codecov
# if: ${{ matrix.python-version == '3.11' }}
# uses: codecov/codecov-action@v3
# with:
# token: ${{ secrets.CODECOV_TOKEN }}
# flags: unit