ci: Migrate workflows to use Makefile targets and pyproject.toml deps. by nedseb · Pull Request #233 · steamicc/micropython-steami-lib

nedseb · 2026-03-24T11:26:37Z

Summary

Closes #230.

Migrates CI workflows to use the Makefile targets introduced in PR #229, creating a single source of truth for commands.

Changes

python-linter.yml:

Install: pip install -r requirements.txt → python3 -m pip install -e ".[dev]"
Lint: ruff check → make lint
Updated actions/checkout v3→v4, actions/setup-python v4→v5

tests.yml:

Install: pip install -r requirements.txt → python3 -m pip install -e ".[dev,test]"
Mock tests: python -m pytest tests/ -v -k mock → make test-mock
Examples: python -m pytest tests/test_examples.py -v → make test-examples
Updated actions/checkout v3→v4, actions/setup-python v4→v5

Removed:

.github/workflows/requirements.txt — deps now in pyproject.toml [project.optional-dependencies]
tests/requirements-test.txt — same reason

Not changed

check-commits.yml — commit format harmonization tracked in ci: Harmonize commit message format between commitlint and check-commits CI. #231

Test plan

make ci passes locally (lint + 164 mock tests + 191 example validations)
CI workflows pass on GitHub after push

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5260b3a1f5

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-03-24T11:29:05Z

-          pip install -r .github/workflows/requirements.txt
-          ruff --version
-          pytest --version
+        run: python3 -m pip install -e ".[dev]"


Avoid editable install in CI dependency step

Using python3 -m pip install -e ".[dev]" causes the job to fail during dependency installation in this repository because setuptools cannot build editable metadata with the current layout (it errors with “Multiple top-level packages discovered in a flat-layout: ['lib', 'reports']”). This means lint/test commands never run; the same regression is also present in .github/workflows/tests.yml with -e ".[dev,test]".

Useful? React with 👍 / 👎.

Copilot

Pull request overview

This PR migrates the GitHub Actions CI workflows to use the repository’s Makefile targets and installs tooling via pyproject.toml optional dependencies, removing duplicated requirements files and making CI commands consistent with local development.

Changes:

Update CI workflows to run make lint, make test-mock, and make test-examples.
Switch dependency installation in CI to python3 -m pip install -e ".[dev]" / python3 -m pip install -e ".[dev,test]".
Remove .github/workflows/requirements.txt and tests/requirements-test.txt.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

File	Description
`.github/workflows/python-linter.yml`	Uses editable install with `.[dev]` and runs `make lint`; updates checkout/setup-python actions.
`.github/workflows/tests.yml`	Uses editable install with `.[dev,test]` and runs `make test-mock` / `make test-examples`; updates checkout/setup-python actions.
`.github/workflows/requirements.txt`	Removed; CI deps intended to come from `pyproject.toml` extras.
`tests/requirements-test.txt`	Removed; test deps intended to come from `pyproject.toml` extras.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-24T11:29:08Z

      - name: "🛠 Install dependencies"
-        run: |
-          pip install -r .github/workflows/requirements.txt
+        run: python3 -m pip install -e ".[dev,test]"


pip install -e ".[dev,test]" requires the repo to be an installable Python project. In the current tree there is no setup.py/setup.cfg, and pyproject.toml lacks a [build-system] section, so this step is likely to fail on a clean CI runner. Consider either (a) adding a minimal [build-system] (e.g., setuptools backend) so editable installs work, or (b) switching CI to install the extras without editable mode using an approach that doesn't require building the project (e.g., a constraints/requirements export).

Suggested change

run: python3 -m pip install -e ".[dev,test]"

run: python3 -m pip install -r requirements-dev.txt

Copilot · 2026-03-24T11:29:09Z

-          pip install -r .github/workflows/requirements.txt
-          ruff --version
-          pytest --version
+        run: python3 -m pip install -e ".[dev]"


Same concern as in tests.yml: this workflow now uses pip install -e ".[dev]", but the repo currently has no setup.py/setup.cfg and pyproject.toml has no [build-system]. On a clean runner this is likely to error because pip can’t build/install the project in editable mode. Add a minimal build backend in pyproject.toml or adjust the install step to avoid editable installs.

Suggested change

run: python3 -m pip install -e ".[dev]"

run: python3 -m pip install ruff

Copilot · 2026-03-24T11:29:09Z

-          pip install -r .github/workflows/requirements.txt
-          ruff --version
-          pytest --version
+        run: python3 -m pip install -e ".[dev]"


This PR removes pinned CI tool versions (ruff==…, pytest==…, pyyaml==…) and replaces them with unpinned ranges via extras. That can make CI results non-reproducible (sudden failures when a new ruff/pytest release lands). If stability is important, consider pinning these versions in pyproject.toml (or using a constraints/lock file that CI installs alongside the extras).

Suggested change

run: python3 -m pip install -e ".[dev]"

run: |

python3 -m pip install -e ".[dev]"

python3 -m pip install "ruff==0.5.0" "pytest==8.3.3" "pyyaml==6.0.2"

Copilot · 2026-03-24T11:29:09Z

-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
        with:
          cache: "pip"


With cache: "pip" and dependencies now defined in pyproject.toml, it may be safer to set cache-dependency-path: pyproject.toml to ensure cache keys update when optional-dependencies change (otherwise caching can become ineffective depending on the action’s dependency-file detection).

Suggested change

cache: "pip"

cache: "pip"

cache-dependency-path: pyproject.toml

nedseb

Addressed all review comments (afaf73e):

Editable install fails (Codex P1) — Already fixed in previous commit with [tool.setuptools] packages = [].
Missing [build-system] (Copilot) — Added [build-system] section with setuptools backend.
Unpinned versions (Copilot) — ruff pinned to 0.11.6, pytest to 7.4.0, pyyaml to 6.0.2 (matching previous CI versions).
cache-dependency-path (Copilot) — Added cache-dependency-path: pyproject.toml to both workflows.

semantic-release-updater · 2026-03-25T10:39:17Z

🎉 This PR is included in version 0.0.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

ci: Migrate workflows to use Makefile targets and pyproject.toml deps.

5260b3a

Copilot AI review requested due to automatic review settings March 24, 2026 11:26

github-actions Bot assigned nedseb Mar 24, 2026

Copilot started reviewing on behalf of nedseb March 24, 2026 11:27 View session

ci: Fix setuptools discovery error for editable install.

e94460c

chatgpt-codex-connector Bot reviewed Mar 24, 2026

View reviewed changes

Copilot AI reviewed Mar 24, 2026

View reviewed changes

nedseb added 2 commits March 24, 2026 13:19

ci: Pin ruff version to avoid rule drift between local and CI.

3f1d259

ci: Add build-system, pin test deps and set cache-dependency-path.

afaf73e

nedseb commented Mar 24, 2026

View reviewed changes

nedseb added the ci CI/CD, workflows, linting label Mar 24, 2026

nedseb merged commit af2902c into main Mar 24, 2026
3 checks passed

nedseb deleted the ci/use-makefile-targets branch March 24, 2026 12:23

semantic-release-updater Bot added the released label Mar 25, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: Migrate workflows to use Makefile targets and pyproject.toml deps.#233

ci: Migrate workflows to use Makefile targets and pyproject.toml deps.#233
nedseb merged 4 commits intomainfrom
ci/use-makefile-targets

nedseb commented Mar 24, 2026

Uh oh!

chatgpt-codex-connector Bot left a comment

Uh oh!

chatgpt-codex-connector Bot Mar 24, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 24, 2026

Uh oh!

Copilot AI Mar 24, 2026

Uh oh!

Copilot AI Mar 24, 2026

Uh oh!

Copilot AI Mar 24, 2026

Uh oh!

nedseb left a comment

Uh oh!

Uh oh!

semantic-release-updater Bot commented Mar 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	run: python3 -m pip install -e ".[dev,test]"
	run: python3 -m pip install -r requirements-dev.txt

	run: python3 -m pip install -e ".[dev]"
	run: python3 -m pip install ruff

	cache: "pip"
	cache: "pip"
	cache-dependency-path: pyproject.toml

Conversation

nedseb commented Mar 24, 2026

Summary

Changes

Not changed

Test plan

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector Bot Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

nedseb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

semantic-release-updater Bot commented Mar 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants