Skip to content

Commit e048932

Browse files
committed
Drop setuptools_scm
It seems that setuptools_scm doesn't work well with pre-commit based installations where there isn't either a built package or a git repository to get the version info from. As well, the version needs to be incremented in the README, so it makes sense to switch to manually setting the version info.
1 parent f7c7d1e commit e048932

4 files changed

Lines changed: 23 additions & 5 deletions

File tree

README.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,24 @@ You can also insert the name of the source docx file using Python format string
159159
args:
160160
- "--header"
161161
- "This file is autogenerated from {docx}. Do not edit."
162+
163+
Development guide
164+
=================
165+
166+
Release procedure
167+
-----------------
168+
169+
From the pull request:
170+
171+
1. Update the `changelog <CHANGELOG.rst>`__
172+
2. Update the version numbers in the ``.pre-commit-config.yaml`` code samples in the README.
173+
3. Update the version in `setup.cfg <setup.cfg>`__.
174+
175+
Next, merge the PR to the ``main`` branch once checks pass.
176+
177+
Finally, create a Release using the GitHub Release UI from the ``main`` branch. The tag name should be the semantic version set in the first step.
178+
179+
Project information
180+
===================
181+
182+
pre-commit-docx-plain is developed and maintained by J.Sick Codes Inc.

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
[build-system]
22
requires = [
33
"setuptools>=42",
4-
"wheel",
5-
"setuptools_scm[toml]>=3.4"
4+
"wheel"
65
]
76
build-backend = 'setuptools.build_meta'
87

setup.cfg

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@ package_dir =
2929
= src
3030
packages = find:
3131
python_requires = >=3.7
32-
setup_requires =
33-
setuptools_scm
3432
install_requires =
3533
importlib_metadata; python_version < "3.8"
3634
pypandoc

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
from setuptools import setup
22

3-
setup(use_scm_version=True)
3+
setup()

0 commit comments

Comments
 (0)