File: packaging.rst

package info (click to toggle)
python-parsl 2025.01.13%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 12,072 kB
  • sloc: python: 23,817; makefile: 349; sh: 276; ansic: 45
file content (46 lines) | stat: -rw-r--r-- 1,145 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
Packaging
---------

Currently packaging is managed by @annawoodard and @yadudoc.

Steps to release

1. Update the version number in ``parsl/parsl/version.py``
2. Check the following files to confirm new release information
   * ``parsl/setup.py``
   * ``requirements.txt``
   * ``parsl/docs/devguide/changelog.rst``
   * ``parsl/README.rst``

3. Commit and push the changes to github
4. Run the ``tag_and_release.sh`` script. This script will verify that
   version number matches the version specified.

   .. code:: bash

      ./tag_and_release.sh <VERSION_FOR_TAG>


Here are the steps that is taken by the ``tag_and_release.sh`` script:

.. code:: bash

   # Create a new git tag :
   git tag <MAJOR>.<MINOR>.<BUG_REV>
   # Push tag to github :
   git push origin <TAG_NAME>

   # Depending on permission all of the following might have to be run as root.
   sudo su

   # Make sure to have twine installed
   pip3 install twine

   # Create a source distribution
   python3 setup.py sdist

   # Create a wheel package, which is a prebuilt package
   python3 setup.py bdist_wheel

   # Upload the package with twine
   twine upload dist/*