Skip to content

Update SETUPTOOLS_SCM_OVERRIDES format in docs #1240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RonnyPfannschmidt merged 2 commits into from
Nov 30, 2025
Merged

Update SETUPTOOLS_SCM_OVERRIDES format in docs #1240

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23b9a4e
Update SETUPTOOLS_SCM_OVERRIDES format in docs
greatvovan Nov 29, 2025
45f969a
Merge branch 'main' into main
RonnyPfannschmidt Nov 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/integrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ jobs:
env:
# Replace MYPACKAGE with your actual package name (normalized)
# For package "my-awesome.package", use "MY_AWESOME_PACKAGE"
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'

steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -154,7 +154,7 @@ jobs:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
env:
# Replace MYPACKAGE with your actual package name (normalized)
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'

steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -246,7 +246,7 @@ publish-test-pypi:
TWINE_USERNAME: __token__
TWINE_PASSWORD: $TEST_PYPI_API_TOKEN
# Replace MYPACKAGE with your actual package name (normalized)
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
script:
- pip install build twine
- python -m build
Expand All @@ -261,7 +261,7 @@ publish-pypi:
TWINE_USERNAME: __token__
TWINE_PASSWORD: $PYPI_API_TOKEN
# Replace MYPACKAGE with your actual package name (normalized)
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
script:
- pip install build twine
- python -m build
Expand Down Expand Up @@ -296,7 +296,7 @@ The environment variable `SETUPTOOLS_SCM_OVERRIDES_FOR_${DIST_NAME}` must be set

2. **Value** must be a valid TOML inline table format:
```bash
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE='{"local_scheme": "no-local-version"}'
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE='{local_scheme = "no-local-version"}'
```

#### Alternative Approaches
Expand Down Expand Up @@ -342,4 +342,4 @@ print(f"SETUPTOOLS_SCM_OVERRIDES_FOR_{env_var_name}")
# Output: SETUPTOOLS_SCM_OVERRIDES_FOR_MY_AWESOME_PACKAGE
```

**Fetch depth**: Always use `fetch-depth: 0` in GitHub Actions to ensure setuptools-scm has access to the full git history for proper version calculation.
**Fetch depth**: Always use `fetch-depth: 0` in GitHub Actions to ensure setuptools-scm has access to the full git history for proper version calculation.
Loading