pypa/hatch

`hatch version` doesn't work on a `setuptools-scm` project unless `hatch-vcs` is installed

Open

#2,069 opened on Oct 2, 2025

View on GitHub
 (15 comments) (0 reactions) (0 assignees)Python (240 forks)batch import
buggood first issue

Repository metrics

Stars
 (4,451 stars)
PR merge metrics
 (Avg merge 71d 21h) (10 merged PRs in 30d)

Description

I get a traceback like this when I try:

Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "/Users/glyph/Library/Application Support/hatch/env/virtual/automat/rI8sZPBT/automat-build/lib/python3.13/site-packages/hatchling/__main__.py", line 6, in <module>
    sys.exit(hatchling())
             ~~~~~~~~~^^
  File "/Users/glyph/Library/Application Support/hatch/env/virtual/automat/rI8sZPBT/automat-build/lib/python3.13/site-packages/hatchling/cli/__init__.py", line 26, in hatchling
    command(**kwargs)
    ~~~~~~~^^^^^^^^^^
  File "/Users/glyph/Library/Application Support/hatch/env/virtual/automat/rI8sZPBT/automat-build/lib/python3.13/site-packages/hatchling/cli/version/__init__.py", line 31, in version_impl
    source = metadata.hatch.version.source
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/glyph/Library/Application Support/hatch/env/virtual/automat/rI8sZPBT/automat-build/lib/python3.13/site-packages/hatchling/metadata/core.py", line 1503, in source
    raise UnknownPluginError(message)
hatchling.plugin.exceptions.UnknownPluginError: Unknown version source: vcs

see this conversation https://github.com/glyph/automat/commit/643f7ce4ff0dfbe0269d57e0611b24fd5a149d93#r163303552

Contributor guide

Research direction
Investigate how hatchling resolves version sources when setuptools scm is configured without hatch vcs. The traceback shows UnknownPluginError for 'vcs' source. Determine if the error message should suggest installing hatch vcs or if hatchling should gracefully fall back. Consider checking the version source configuration and plugin loading logic.
Tech stack
python
Domain
cli
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Pythonhatchlingplugin systems
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60