Skip to content

Commit 6bfeca6

Browse files
committed
Housecleaning. Also for cherry picking on to master.
- Fix links in conf.py - Update MANIFEST.in to include static JavaScript files - Use modern tools like tox for making a release
1 parent 72a6fcb commit 6bfeca6

File tree

4 files changed

+26
-27
lines changed

4 files changed

+26
-27
lines changed

MANIFEST.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ include lingua.ini tox.ini
99
include i18n.sh run-selenium-tests.bash
1010
include pyproject.toml
1111
include .coveragerc .isort.cfg .flake8
12-
recursive-include deform *.js
12+
recursive-include deform/static *.js
1313

1414
global-exclude __pycache__ *.py[cod]

RELEASING.txt

+21-24
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,16 @@ Prepare new release branch
2323

2424
- On release branch:
2525

26-
$ git pull
27-
28-
- Do platform test via tox:
26+
git pull
2927

3028
- Make sure your Python has ``setuptools-git``, ``twine``, and ``wheel``
3129
installed:
3230

33-
$ $VENV/bin/easy_install setuptools-git twine wheel
31+
$VENV/bin/pip install setuptools-git twine wheel
3432

3533
- Do a platform test:
3634

37-
$ tox -r
35+
tox -r
3836

3937
- Ensure all features of the release are documented (audit CHANGES.txt or
4038
communicate with contributors).
@@ -44,9 +42,6 @@ Prepare new release branch
4442
- Update README.rst to use correct versions of badges and URLs according to
4543
each branch and context, i.e., RTD "latest" == GitHub/Travis "2.0-branch".
4644

47-
- Update whatsnew-X.X.rst in docs to point at change log entries for
48-
individual releases if applicable.
49-
5045
- For major version releases, in contributing.md, update branch descriptions.
5146

5247
- For major version releases, in docs/conf.py, update values under
@@ -56,26 +51,26 @@ Prepare new release branch
5651

5752
- Change setup.py version to the release version number.
5853

59-
- Make sure PyPI long description renders (requires ``collective.dist``
60-
installed into your Python)::
54+
- Run a check with black, ensure the PyPI long description renders, and run
55+
check-manifest with the following command.
6156

62-
$ $VENV/bin/python setup.py check -r
57+
$VENV/bin/tox -e lint
6358

6459
- Build an sdist and a wheel:
6560

66-
$ $VENV/bin/python setup.py sdist bdist_wheel
61+
$VENV/bin/tox -e build
6762

6863
- Release the wheels to PyPI:
6964

70-
$ $VENV/bin/twine upload dist/deform-X.Y*
65+
$VENV/bin/twine upload dist/deform-X.Y.Z*
7166

7267
- Upload a git tag for the release:
7368

74-
$ git tag X.Y
75-
$ git push origin X.Y
69+
git tag X.Y.Z
70+
git push origin X.Y.Z
7671

77-
- Update RTD to render a new version of the docs at that tag X.Y and set X.Y
78-
as the default branch such that /latest/ points to it.
72+
- Update RTD to render a new version of the docs at that tag X.Y.Z and set
73+
X.Y.Z as the default branch such that ``/latest/`` points to it.
7974

8075
- Publish new version of docs.
8176

@@ -87,7 +82,7 @@ Prepare new release branch
8782
Deform 2.x released.
8883

8984
PyPI
90-
https://pypi.python.org/pypi/deform/2.x
85+
https://pypi.org/project/deform/2.X.X
9186

9287
=== One time only for new version, first pre-release ===
9388
What's New
@@ -109,15 +104,17 @@ Here are the changes:
109104

110105
<<changes>>
111106

112-
Links
107+
Widget demos
108+
https://deformdemo.repoze.org/
113109

114-
- Widget demos http://deformdemo.repoze.org/
110+
Documentation
111+
https://docs.pylonsproject.org/projects/deform/en/latest/
115112

116-
- Documentation http://docs.pylonsproject.org/projects/deform/en/master/
113+
GitHub
114+
https://github.com/pylons/deform
117115

118-
- Github https://github.com/pylons/deform
119-
120-
- PyPi https://pypi.python.org/pypi/deform/
116+
PyPI
117+
https://pypi.org/project/deform/2.X.X
121118

122119
Enjoy, and please report any issues you find to the issue tracker at
123120
https://github.com/Pylons/deform/issues

docs/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
intersphinx_mapping = {
3939
'colander': ('https://docs.pylonsproject.org/projects/colander/en/latest/', None),
4040
'pyramid': ('https://docs.pylonsproject.org/projects/pyramid/en/latest', None),
41-
'python': ('https://docs.python.org/dev/', None),
41+
'python': ('https://docs.python.org/3/', None),
4242
}
4343

4444
# Add any paths that contain templates here, relative to this directory.
@@ -226,7 +226,7 @@
226226

227227
# The unique identifier of the text. This can be a ISBN number
228228
# or the project homepage.
229-
epub_identifier = 'https://deform.readthedocs.org/'
229+
epub_identifier = 'https://docs.pylonsproject.org/projects/deform/en/latest/'
230230

231231
# A unique identification for the text.
232232
epub_uid = epub_title

tox.ini

+2
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,10 @@ commands =
7979
pip install deform[testing,functional]
8080
./run-selenium-tests.bash --with-flaky --max-runs=4 {posargs}
8181

82+
8283
[testenv:build]
8384
skip_install = true
85+
basepython = python3.8
8486
commands =
8587
# clean up build/ and dist/ folders
8688
python -c 'import shutil; shutil.rmtree("dist", ignore_errors=True)'

0 commit comments

Comments
 (0)