From 46c7a2d936f7c5032e77eed5ccc2ab478658c34f Mon Sep 17 00:00:00 2001 From: bcrawford39GT <130703978+bcrawford39GT@users.noreply.github.com> Date: Wed, 28 Jan 2026 16:11:38 -0500 Subject: [PATCH 1/8] Create pull_request_template.md --- .github/workflows/pull_request_template.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .github/workflows/pull_request_template.md diff --git a/.github/workflows/pull_request_template.md b/.github/workflows/pull_request_template.md new file mode 100644 index 0000000..0f4ae52 --- /dev/null +++ b/.github/workflows/pull_request_template.md @@ -0,0 +1,4 @@ +### PR Checklist +- [ ] Perform self-review of code +- [ ] Add unit tests +- [ ] Update documentation From d50a7dd2d3f903fb8ea19df6d781527554a393b7 Mon Sep 17 00:00:00 2001 From: bcrawford39GT <130703978+bcrawford39GT@users.noreply.github.com> Date: Wed, 28 Jan 2026 16:13:21 -0500 Subject: [PATCH 2/8] Create pull_request_template.md --- .github/pull_request_template.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..0f4ae52 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,4 @@ +### PR Checklist +- [ ] Perform self-review of code +- [ ] Add unit tests +- [ ] Update documentation From b36cb8636ab41b55297b5ef67debd86599b3a57e Mon Sep 17 00:00:00 2001 From: bcrawford39GT <130703978+bcrawford39GT@users.noreply.github.com> Date: Wed, 28 Jan 2026 16:13:40 -0500 Subject: [PATCH 3/8] Update pull_request_template.md --- .github/workflows/pull_request_template.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/pull_request_template.md b/.github/workflows/pull_request_template.md index 0f4ae52..8b13789 100644 --- a/.github/workflows/pull_request_template.md +++ b/.github/workflows/pull_request_template.md @@ -1,4 +1 @@ -### PR Checklist -- [ ] Perform self-review of code -- [ ] Add unit tests -- [ ] Update documentation + From 83276e4498241363a6d2282a405acedf01cf3457 Mon Sep 17 00:00:00 2001 From: bcrawford39GT <130703978+bcrawford39GT@users.noreply.github.com> Date: Wed, 28 Jan 2026 16:14:03 -0500 Subject: [PATCH 4/8] Delete .github/workflows directory --- .github/workflows/pull_request_template.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .github/workflows/pull_request_template.md diff --git a/.github/workflows/pull_request_template.md b/.github/workflows/pull_request_template.md deleted file mode 100644 index 8b13789..0000000 --- a/.github/workflows/pull_request_template.md +++ /dev/null @@ -1 +0,0 @@ - From 144df20db978c58cd325be16423b0c71888e1704 Mon Sep 17 00:00:00 2001 From: bcrawford39GT <130703978+bcrawford39GT@users.noreply.github.com> Date: Wed, 28 Jan 2026 16:16:44 -0500 Subject: [PATCH 5/8] Create CI.yml --- .github/workflows/CI.yml | 58 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 .github/workflows/CI.yml diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml new file mode 100644 index 0000000..223cc32 --- /dev/null +++ b/.github/workflows/CI.yml @@ -0,0 +1,58 @@ +ame: CI + +# Controls when the workflow will run +on: + # Triggers the workflow on push or pull request events but only for the main branch + push: + branches: [ main ] + pull_request: + branches: [ main ] + # run 1 time per month (on the 1st day of the month at 6:40 AM) = "40 6 1 * *" + # run 1 time per week on Monday at 6:40 AM = "40 6 * * 1" + schedule: + - cron: "40 6 * * 1" + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + Mambaforge-pytest: + name: Unit-Test (${{ matrix.os }}, Python ${{ matrix.python-version }}) + runs-on: ${{ matrix.os }}-latest + strategy: + fail-fast: false + matrix: + python-version: ["3.12"] + os: ["macos", "windows", "ubuntu"] + include: + - os: macos + - environment-file: environment.yml + - os: windows + environment-file: environment.yml + - os: ubuntu + environment-file: environment.yml + + steps: + - name: Checkout Branch / Pull Request + uses: actions/checkout@v4 + + - name: Install Mamba + uses: mamba-org/setup-micromamba@v2 + with: + environment-file: ${{ matrix.environment-file }} + python-version: ${{ matrix.python-version }} + use-mamba: true + + - shell: bash -l {0} + run: | + pip install . + + - shell: bash -l {0} + name: Test (OS -> ${{ matrix.os }} / Python -> ${{ matrix.python-version }}) + run: python -m pytest -v --color yes python_github_tutorial/tests --cov + #run: python -m pytest -v --cov=python_github_tutorial --cov-report=xml --cov-append --cov-config=setup.cfg --color yes python_github_tutorial/tests + #echo "tests finished" + + #- name: Upload coverage reports to Codecov + # uses: codecov/codecov-action@v3 From d0aa36df6fc08d2ce7bc59a8afa5e5d6be69c117 Mon Sep 17 00:00:00 2001 From: bcrawford39GT <130703978+bcrawford39GT@users.noreply.github.com> Date: Wed, 28 Jan 2026 16:20:05 -0500 Subject: [PATCH 6/8] Update CI.yml --- .github/workflows/CI.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 223cc32..9007331 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -1,4 +1,4 @@ -ame: CI +name: CI # Controls when the workflow will run on: From 9cc7b00807a89fb4315bdf8c4efeaa0b2bafd45e Mon Sep 17 00:00:00 2001 From: bcrawford39GT <130703978+bcrawford39GT@users.noreply.github.com> Date: Wed, 28 Jan 2026 16:22:26 -0500 Subject: [PATCH 7/8] Update environment.yml --- environment.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/environment.yml b/environment.yml index 8e5c3d4..5e69616 100644 --- a/environment.yml +++ b/environment.yml @@ -6,6 +6,8 @@ dependencies: - python - numpy - pytest + - pytest-cov + - coverage - pip - mock - ipython From cc6f7c6e7ff8ad3e06914f399cb56cd45b174a4c Mon Sep 17 00:00:00 2001 From: bcrawford39GT <130703978+bcrawford39GT@users.noreply.github.com> Date: Wed, 28 Jan 2026 16:27:08 -0500 Subject: [PATCH 8/8] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 0222425..1e2e728 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![CI](https://github.com/pace-gt/python_github_tutorial/actions/workflows/CI.yml/badge.svg)](https://github.com/pace-gt/python_github_tutorial/blob/main/.github/workflows/CI.yml) + # python_github_tutorial ## Overview