Skip to content

Commit f1c3e10

Browse files
committed
Fix release procedure, and add documentation
1 parent 7cd8667 commit f1c3e10

File tree

3 files changed

+19
-3
lines changed

3 files changed

+19
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
*.egg-info
44
.eggs
55
__pycache__
6+
/dist
67
docs/_build
78
.coverage
89
coverage.xml

docs/sandbox.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,22 @@ In order to edit or inspect the CSS stylesheet rules, head over to
5050
[`compiled/style.css`]. For editing or inspecting the directive- and
5151
role-implementations, see [`gridtable.py`], [`infocard.py`], and [`tag.py`].
5252

53+
54+
## Releasing
55+
56+
```shell
57+
# Install a few more prerequisites.
58+
pip install --editable=.[release]
59+
60+
# Designate a new version.
61+
git tag v0.1.0
62+
git push --tags
63+
64+
# Build package, and publish to PyPI.
65+
poe release
66+
```
67+
68+
5369
[`compiled/style.css`]: https://github.com/panodata/sphinx-design-elements/blob/main/sphinx_design_elements/compiled/style.css
5470
[`gridtable.py`]: https://github.com/panodata/sphinx-design-elements/blob/main/sphinx_design_elements/gridtable.py
5571
[`infocard.py`]: https://github.com/panodata/sphinx-design-elements/blob/main/sphinx_design_elements/infocard.py

pyproject.toml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ docs = [
7272
]
7373
release = [
7474
"build<1",
75-
'minibump<1; python_version >= "3.10"',
75+
"keyring",
7676
"twine<5",
7777
]
7878
test = [
@@ -218,9 +218,8 @@ lint = [
218218
]
219219

220220
release = [
221-
{ cmd = "minibump bump --relax minor" },
222221
{ cmd = "python -m build" },
223-
{ cmd = "twine upload dist/*" },
222+
{ cmd = "twine upload dist/*.tar.gz dist/*.whl" },
224223
]
225224

226225
test = { cmd = "pytest" }

0 commit comments

Comments
 (0)