pypiserver/bin
2022-05-01 22:36:06 +02:00
..
.gitignore Download git-new-workdir for STANDALONE. 2015-09-14 18:47:33 +02:00
bumpver.py Run black on codebase (#336) 2020-10-05 21:04:22 -05:00
check_readme.sh FIX #154, docs: TC-script checking README RST-compliance for PyPi. 2016-06-28 13:05:11 +02:00
ci_helper.py Push to Docker Hub from CI (#375) 2021-02-07 20:24:33 -06:00
package.sh fix package script usage 2022-05-01 22:36:06 +02:00
README.rst MAINT: drop standalone, drop py 2.7 and 3.5 (#338) 2020-10-03 22:25:14 -05:00
update_changelog.sh chore(release-candidate-from-github-actions): add github action for release management (#417) 2022-03-25 19:31:39 +01:00

====================
Build scripts folder
====================


Files:
======

- ``bumpver.py``             : Bump, commit and tag new project versions
- ``check_readme.sh``        : Check that README has no RsT-syntactic errors.
- ``package.sh``             : Build deployable artifact (wheel) in ``/dist/`` folder.
- ``README.rst``             : This file.


Release check-list:
===================
1. Update ``/CHANGES.rst`` (+ Title + Date) & ``/README.rst`` (Date,
   not version).

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 ``--follow-tags``.

5. Generate package *wheel* with ``/bin/package.sh``.

6. Upload to PyPi with ``twine upload -s -i <gpg-user> dist/*``

7. Ensure that the new tag is built on hub.docker.com as ``latest`` and as a
   direct tag reference.

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.