pypiserver/bin/README.rst
2017-11-01 10:47:28 +02:00

38 lines
1.2 KiB
ReStructuredText

====================
Build scripts folder
====================
Files:
======
- ``bumpver.py`` : Bump, commit and tag new project versions
- ``check_readme.sh`` : Check that README has no RsT-syntactic errors.
- ``commit-standalone.sh`` : Create an executable file and add it into `standalone` branch.
- ``gen-standalone.sh`` : Invoked by `commit-standalone.sh`.
- ``git-new-workdir`` : Invoked by `gen-standalone.sh`.
- ``package.sh`` : Build deployable artifact (wheel) in ``/dist/`` folder.
- ``README.rst`` : This file.
Release check-list:
===================
1. Update ``/CHANGES.rst`` (+ Title + Date) & ``/README.rst``.
2. Push to GitHub to run all TCs once more.
3. Bump version: commit & tag it with ``/bin/bumpver.py``.
Use ``--help``.
Read `PEP-440 <https://www.python.org/dev/peps/pep-0440/`_ to decide the version.
4. Push it in GitHub with ``--tag``.
5. Generate package *wheel* with ``/bin/package.sh``.
6. Upload to PyPi with ``twine upload -su <gpg-user> dist/*``:
7. Run ``commit-standalone.sh``.
8. Copy release notes from ``/CHANGES.rst`` in GitHub as new *"release"* page
on the new tag. Check syntactic differences between ``.md`` and ``.rst`` files.