Skip to content

Remove requirements files and update CI workflow#14

Merged
shenxianpeng merged 4 commits into
mainfrom
remove-requirements
Apr 22, 2026
Merged

Remove requirements files and update CI workflow#14
shenxianpeng merged 4 commits into
mainfrom
remove-requirements

Conversation

@shenxianpeng
Copy link
Copy Markdown
Member

@shenxianpeng shenxianpeng commented Apr 22, 2026

Related Issue

Closes #

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactor / code cleanup
  • CI / build / dependency update
  • Other (describe below)

Checklist

  • Tests pass locally (hatch run test:test)
  • New tests added for new behavior (if applicable)
  • Documentation updated (if applicable)
  • CHANGELOG / release notes updated (if applicable)

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR removes generated/pinned requirements files and updates the docs CI workflow to build/deploy documentation via Hatch instead of installing from requirements/requirements-docs.txt.

Changes:

  • Delete the autogenerated requirements/requirements-style.txt and requirements/requirements-docs.txt files.
  • Update pyproject.toml to remove hatch-pip-compile usage and drop pip-compile env types.
  • Update .github/workflows/docs.yml to run docs build/deploy via hatch run instead of direct mkdocs commands.

Reviewed changes

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

File Description
requirements/requirements-style.txt Removed pinned style tool dependency lockfile.
requirements/requirements-docs.txt Removed pinned docs dependency lockfile.
pyproject.toml Removes hatch-pip-compile requirement and pip-compile env types for style/docs.
.github/workflows/docs.yml Switch docs CI to install Hatch and run hatch run docs:build/deploy.
Comments suppressed due to low confidence (1)

pyproject.toml:177

  • style previously used type = "pip-compile" with a generated requirements file that pinned formatter/linter versions. After removing the pip-compile env type, black/isort/ruff are now unpinned, which can change CI behavior over time and potentially diverge from the pinned tool versions in .pre-commit-config.yaml. Consider pinning these tool versions in the Hatch style env dependencies (or otherwise ensuring CI and pre-commit use the same versions).
[tool.hatch.envs.style]
detached = true
dependencies = [
    "black",
    "isort",
    "ruff",
]

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

Comment thread .github/workflows/docs.yml
Comment on lines +18 to +20
run: pip install hatch
- name: Build site
run: mkdocs build --strict
run: hatch run docs:build
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

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

By switching the docs job from a fully pinned requirements-docs.txt install to hatch run docs:build, the versions of the docs build toolchain become implicit and may drift over time, which can make scheduled builds/deploys flaky. If reproducible docs builds are desired, consider introducing a lock/pin mechanism for the docs environment (e.g., pin key docs plugins in Hatch env deps, or adopt a lock file approach) to replace the removed requirements file.

Copilot uses AI. Check for mistakes.
Copilot AI and others added 3 commits April 22, 2026 18:29
@shenxianpeng shenxianpeng merged commit 7bfd75f into main Apr 22, 2026
46 checks passed
@shenxianpeng shenxianpeng deleted the remove-requirements branch April 22, 2026 21:45
@shenxianpeng shenxianpeng added enhancement New feature or request and removed developer labels Apr 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants