Skip to main content

Zero-dependency CLI to verify package.json, CHANGELOG.md, and git tag all share the same version — catch release mistakes before they ship.

Project description

verscan

Zero-dependency CLI to verify that package.json (or pyproject.toml), CHANGELOG.md, and your latest git tag all agree on the same version number — before you ship.

$ verscan

  ✓ pyproject.toml  0.3.1  (reference)
  ✓ CHANGELOG.md    0.3.1
  ✓ git tag         0.3.1

verscan: all sources match → 0.3.1

Install

pip install verscan

No dependencies. Python ≥ 3.8 required.

Usage

verscan [options] [dir]
Option Description
--no-git Skip git tag check
--no-changelog Skip CHANGELOG.md check
--manifest <file> Custom manifest path (default: auto-detect)
--changelog <file> Custom changelog path (default: CHANGELOG.md)
--json Output JSON
--version Print verscan version
--help Show help

Exit codes: 0 all match · 1 mismatch · 2 parse/read error

Examples

verscan                      # check current directory
verscan --no-git             # skip git tag (before tagging)
verscan ./packages/api       # check a sub-package
verscan --json | python3 -c "import sys,json; d=json.load(sys.stdin); sys.exit(0 if d['ok'] else 1)"

CI integration

- name: Verify versions aligned
  run: pip install verscan && verscan

For the Node.js CLI counterpart, see verscan.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

verscan-0.1.0.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

verscan-0.1.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file verscan-0.1.0.tar.gz.

File metadata

  • Download URL: verscan-0.1.0.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for verscan-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a4dcad74d713bf2731e051d64570a0e4ad3fe999d23fbfb22035a65f8c3b29dd
MD5 2f0241ae1b2f59ab3977e91536c668ff
BLAKE2b-256 2d9e82ae34a10e8a0628d7a5b640ec93068c7da4676cf16f787bc1864a8a2af1

See more details on using hashes here.

File details

Details for the file verscan-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: verscan-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for verscan-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6dd14222e92dcec82cbdb8c1aad4629a8f120b22847a155dc6c599b9130f9a6d
MD5 30c0da681462ee9c086ca46ad1d28a5f
BLAKE2b-256 cdf6173ae53aa4e1271263cb3ccb16eb992ba8db7988a524b0c015254945fa09

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page