Skip to content

Commit 55dc58c

Browse files
Merge pull request #1240 from greatvovan/main
Update SETUPTOOLS_SCM_OVERRIDES format in docs
2 parents 266b73f + 45f969a commit 55dc58c

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/integrations.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ jobs:
122122
env:
123123
# Replace MYPACKAGE with your actual package name (normalized)
124124
# For package "my-awesome.package", use "MY_AWESOME_PACKAGE"
125-
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
125+
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
126126
127127
steps:
128128
- uses: actions/checkout@v4
@@ -154,7 +154,7 @@ jobs:
154154
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
155155
env:
156156
# Replace MYPACKAGE with your actual package name (normalized)
157-
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
157+
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
158158
159159
steps:
160160
- uses: actions/checkout@v4
@@ -246,7 +246,7 @@ publish-test-pypi:
246246
TWINE_USERNAME: __token__
247247
TWINE_PASSWORD: $TEST_PYPI_API_TOKEN
248248
# Replace MYPACKAGE with your actual package name (normalized)
249-
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
249+
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
250250
script:
251251
- pip install build twine
252252
- python -m build
@@ -261,7 +261,7 @@ publish-pypi:
261261
TWINE_USERNAME: __token__
262262
TWINE_PASSWORD: $PYPI_API_TOKEN
263263
# Replace MYPACKAGE with your actual package name (normalized)
264-
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{"local_scheme": "no-local-version"}'
264+
SETUPTOOLS_SCM_OVERRIDES_FOR_MYPACKAGE: '{local_scheme = "no-local-version"}'
265265
script:
266266
- pip install build twine
267267
- python -m build
@@ -296,7 +296,7 @@ The environment variable `SETUPTOOLS_SCM_OVERRIDES_FOR_${DIST_NAME}` must be set
296296

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

302302
#### Alternative Approaches
@@ -342,4 +342,4 @@ print(f"SETUPTOOLS_SCM_OVERRIDES_FOR_{env_var_name}")
342342
# Output: SETUPTOOLS_SCM_OVERRIDES_FOR_MY_AWESOME_PACKAGE
343343
```
344344

345-
**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.
345+
**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.

0 commit comments

Comments
 (0)