Skip to content

feat: add version management and CI/CD workflow, add pre-commit hook …#3

Merged
zhengxuyu merged 1 commit intomainfrom
version-control
Jan 26, 2026
Merged

feat: add version management and CI/CD workflow, add pre-commit hook …#3
zhengxuyu merged 1 commit intomainfrom
version-control

Conversation

@zhengxuyu
Copy link
Collaborator

This pull request introduces a new version management workflow that replaces automatic patch version increments in CI with a pre-commit hook that enforces version updates for all code changes. The changes ensure developers manually update the version when making code changes, with clear instructions and tooling support. The documentation and tooling have been updated to reflect and support this new process.

Version management workflow changes:

  • Removed the automatic version increment job from the GitHub Actions CI workflow, so patch version bumps are no longer handled automatically on push to main/master.
  • Added a pre-commit hook script (scripts/pre-commit-version-check.sh) that checks for version updates whenever code changes are committed. The hook blocks commits with code changes unless the version number in fastskills/__version__ is updated and staged.
  • Updated the Makefile to add an install-hook target for installing the pre-commit hook, and documented the new target in the help section. [1] [2] [3]

Documentation updates:

  • Revised the README.md to reflect the new manual version management process, including:
    • Instructions for installing and using the pre-commit hook.
    • Updated versioning workflow and requirements for contributors.
    • Added a checklist item to ensure version updates are included in code changes and that the pre-commit hook passes. [1] [2] [3] [4]

Version bump:

  • Bumped the project version from 0.1.0 to 0.1.1 in fastskills/__version__ to reflect the changes.…for version checking

Copilot AI review requested due to automatic review settings January 26, 2026 11:14
Copy link
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 switches from CI-driven automatic patch version increments to a local, enforced versioning workflow using a pre-commit hook, plus corresponding tooling and documentation updates.

Changes:

  • Added a scripts/pre-commit-version-check.sh hook and make install-hook target to enforce that any code changes include a version bump in fastskills/__version__.
  • Removed the CI/CD auto-version-increment job from .github/workflows/ci.yml.
  • Updated README.md to describe the new manual version management workflow, contributor checklist items, and pre-commit hook usage; bumped the project version from 0.1.0 to 0.1.1.

Reviewed changes

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

Show a summary per file
File Description
scripts/pre-commit-version-check.sh New pre-commit hook that inspects staged changes and blocks commits with code changes unless fastskills/__version__ is updated and staged.
fastskills/__version__ Bumps project version from 0.1.0 to 0.1.1 to reflect workflow changes.
README.md Documents the new version management workflow, pre-commit hook installation/behavior, and expands the contributor checklist to require version updates.
Makefile Adds install-hook target and help entry to install the pre-commit version-check hook into .git/hooks/pre-commit.
.github/workflows/ci.yml Removes the auto-version job so CI no longer auto-increments patch versions on pushes to main/master.

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

@zhengxuyu zhengxuyu merged commit d1b47a4 into main Jan 26, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants