Skip to content

Commit

Permalink
Housecleaning. Also for cherry picking on to master.
Browse files Browse the repository at this point in the history
- Fix links in conf.py
- Update MANIFEST.in to include static JavaScript files
- Use modern tools like tox for making a release
  • Loading branch information
stevepiercy committed Jul 3, 2020
1 parent 72a6fcb commit 6bfeca6
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 27 deletions.
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ include lingua.ini tox.ini
include i18n.sh run-selenium-tests.bash
include pyproject.toml
include .coveragerc .isort.cfg .flake8
recursive-include deform *.js
recursive-include deform/static *.js

global-exclude __pycache__ *.py[cod]
45 changes: 21 additions & 24 deletions RELEASING.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,16 @@ Prepare new release branch

- On release branch:

$ git pull

- Do platform test via tox:
git pull

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

$ $VENV/bin/easy_install setuptools-git twine wheel
$VENV/bin/pip install setuptools-git twine wheel

- Do a platform test:

$ tox -r
tox -r

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

- Update whatsnew-X.X.rst in docs to point at change log entries for
individual releases if applicable.

- For major version releases, in contributing.md, update branch descriptions.

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

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

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

$ $VENV/bin/python setup.py check -r
$VENV/bin/tox -e lint

- Build an sdist and a wheel:

$ $VENV/bin/python setup.py sdist bdist_wheel
$VENV/bin/tox -e build

- Release the wheels to PyPI:

$ $VENV/bin/twine upload dist/deform-X.Y*
$VENV/bin/twine upload dist/deform-X.Y.Z*

- Upload a git tag for the release:

$ git tag X.Y
$ git push origin X.Y
git tag X.Y.Z
git push origin X.Y.Z

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

- Publish new version of docs.

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

PyPI
https://pypi.python.org/pypi/deform/2.x
https://pypi.org/project/deform/2.X.X

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

<<changes>>

Links
Widget demos
https://deformdemo.repoze.org/

- Widget demos http://deformdemo.repoze.org/
Documentation
https://docs.pylonsproject.org/projects/deform/en/latest/

- Documentation http://docs.pylonsproject.org/projects/deform/en/master/
GitHub
https://github.com/pylons/deform

- Github https://github.com/pylons/deform

- PyPi https://pypi.python.org/pypi/deform/
PyPI
https://pypi.org/project/deform/2.X.X

Enjoy, and please report any issues you find to the issue tracker at
https://github.com/Pylons/deform/issues
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
intersphinx_mapping = {
'colander': ('https://docs.pylonsproject.org/projects/colander/en/latest/', None),
'pyramid': ('https://docs.pylonsproject.org/projects/pyramid/en/latest', None),
'python': ('https://docs.python.org/dev/', None),
'python': ('https://docs.python.org/3/', None),
}

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -226,7 +226,7 @@

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

# A unique identification for the text.
epub_uid = epub_title
Expand Down
2 changes: 2 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,10 @@ commands =
pip install deform[testing,functional]
./run-selenium-tests.bash --with-flaky --max-runs=4 {posargs}


[testenv:build]
skip_install = true
basepython = python3.8
commands =
# clean up build/ and dist/ folders
python -c 'import shutil; shutil.rmtree("dist", ignore_errors=True)'
Expand Down

0 comments on commit 6bfeca6

Please sign in to comment.