chore: update the ci pipeline to match other patterns

.github/workflows/tests.yml → .github/workflows/ci-build.yml

@@ -1,4 +1,4 @@
-name: Run all the unit tests
+name: Python CI
 
 on:
  push:
@@ -9,8 +9,46 @@ on:
  - cron: "0 0 * * *"
  workflow_dispatch:
 
+env:
+ LATEST_SUPPORTED_PY: "3.14"
+
 jobs:
- build:
+ lint:
+ name: Lint
+ runs-on: ubuntu-latest
+ timeout-minutes: 5
+ permissions:
+ contents: read
+ steps:
+ - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+ with:
+ persist-credentials: false
+ - name: Set up Python ${{ env.LATEST_SUPPORTED_PY }}
+ uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
+ with:
+ python-version: ${{ env.LATEST_SUPPORTED_PY }}
+ - name: Run lint verification
+ run: ./scripts/lint.sh
+
+ typecheck:
+ name: Typecheck
+ runs-on: ubuntu-latest
+ timeout-minutes: 5
+ permissions:
+ contents: read
+ steps:
+ - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+ with:
+ persist-credentials: false
+ - name: Set up Python ${{ env.LATEST_SUPPORTED_PY }}
+ uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
+ with:
+ python-version: ${{ env.LATEST_SUPPORTED_PY }}
+ - name: Run mypy verification
+ run: ./scripts/run_mypy.sh
+
+ unittest:
+ name: Unit tests
  runs-on: ubuntu-22.04
  timeout-minutes: 10
  strategy:
@@ -85,10 +123,48 @@ jobs:
  report_type: test_results
  token: ${{ secrets.CODECOV_TOKEN }}
  verbose: true
+
+ codecov:
+ name: Code Coverage
+ runs-on: ubuntu-latest
+ timeout-minutes: 10
+ permissions:
+ contents: read
+ env:
+ BOLT_PYTHON_CODECOV_RUNNING: "1"
+ steps:
+ - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+ with:
+ persist-credentials: false
+ - name: Set up Python ${{ env.LATEST_SUPPORTED_PY }}
+ uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
+ with:
+ python-version: ${{ env.LATEST_SUPPORTED_PY }}
+ - name: Install dependencies
+ run: |
+ pip install -U pip
+ pip install .
+ pip install -r requirements/adapter.txt
+ pip install -r requirements/testing.txt
+ pip install -r requirements/adapter_testing.txt
+ - name: Run all tests for codecov
+ run: |
+ pytest --cov=./slack_bolt/ --cov-report=xml
+ - name: Upload coverage to Codecov
+ uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2
+ with:
+ fail_ci_if_error: true
+ report_type: coverage
+ token: ${{ secrets.CODECOV_TOKEN }}
+ verbose: true
+
  notifications:
  name: Regression notifications
  runs-on: ubuntu-latest
- needs: build
+ needs:
+ - lint
+ - typecheck
+ - unittest
  if: ${{ !success() && github.ref == 'refs/heads/main' && github.event_name != 'workflow_dispatch' }}
  steps:
  - name: Send notifications of failing tests

scripts/format.sh

@@ -4,7 +4,10 @@
 script_dir=`dirname $0`
 cd ${script_dir}/..
 
-pip install -U pip
-pip install -U -r requirements/tools.txt
+if [[ "$1" != "--no-install" ]]; then
+ export PIP_REQUIRE_VIRTUALENV=1
+ pip install -U pip
+ pip install -U -r requirements/tools.txt
+fi
 
 black slack_bolt/ tests/

scripts/install_all_and_run_tests.sh

@@ -16,25 +16,20 @@ pip uninstall python-lambda
 test_target="$1"
 
 pip install -U -e .
+pip install -U -r requirements/testing.txt
+pip install -U -r requirements/adapter.txt
+pip install -U -r requirements/adapter_testing.txt
+pip install -U -r requirements/tools.txt
+# To avoid errors due to the old versions of click forced by Chalice
+pip install -U pip click
 
 if [[ $test_target != "" ]]
 then
- pip install -U -r requirements/testing.txt && \
- pip install -U -r requirements/adapter.txt && \
- pip install -U -r requirements/adapter_testing.txt && \
- # To avoid errors due to the old versions of click forced by Chalice
- pip install -U pip click && \
- black slack_bolt/ tests/ && \
+ ./scripts/format.sh --no-install
  pytest $1
 else
- pip install -U -r requirements/testing.txt && \
- pip install -U -r requirements/adapter.txt && \
- pip install -U -r requirements/adapter_testing.txt && \
- pip install -r requirements/tools.txt && \
- # To avoid errors due to the old versions of click forced by Chalice
- pip install -U pip click && \
- black slack_bolt/ tests/ && \
- flake8 slack_bolt/ && flake8 examples/
- pytest && \
- mypy --config-file pyproject.toml
+ ./scripts/format.sh --no-install
+ ./scripts/lint.sh --no-install
+ pytest
+ ./scripts/run_mypy.sh --no-install
 fi

scripts/lint.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# ./scripts/lint.sh
+
+script_dir=$(dirname $0)
+cd ${script_dir}/..
+
+if [[ "$1" != "--no-install" ]]; then
+ pip install -U pip
+ pip install -U -r requirements/tools.txt
+fi
+
+flake8 slack_bolt/ && flake8 examples/

scripts/run_mypy.sh

@@ -2,9 +2,14 @@
 # ./scripts/run_mypy.sh
 
 script_dir=$(dirname $0)
-cd ${script_dir}/.. && \
+cd ${script_dir}/..
+
+if [[ "$1" != "--no-install" ]]; then
+ pip install -U pip
  pip install -U .
- pip install -U -r requirements/async.txt && \
- pip install -U -r requirements/adapter.txt && \
- pip install -U -r requirements/tools.txt && \
- mypy --config-file pyproject.toml
+ pip install -U -r requirements/async.txt
+ pip install -U -r requirements/adapter.txt
+ pip install -U -r requirements/tools.txt
+fi
+
+mypy --config-file pyproject.toml

scripts/run_tests.sh

@@ -7,12 +7,12 @@ script_dir=`dirname $0`
 cd ${script_dir}/..
 
 test_target="$1"
-python_version=`python --version | awk '{print $2}'`
+
+./scripts/format.sh --no-install
 
 if [[ $test_target != "" ]]
 then
- black slack_bolt/ tests/ && \
- pytest -vv $1
+ pytest -vv $1
 else
-black slack_bolt/ tests/ && pytest
+ pytest
 fi