|
1 | 1 | Building Releases |
2 | 2 | ================= |
3 | 3 |
|
4 | | -Roundup is currently a source-only release - it has no binary components. I |
5 | | -want it to stay that way, too. This document describes how to build a |
6 | | -source release. Users of Roundup should read the doc/installation.txt file |
7 | | -to find out how to install this software. |
| 4 | +Roundup is a pure Python application with no binary components. This file |
| 5 | +describes how to build a source release. To find out how to install |
| 6 | +Roundup, read the doc/installation.txt file. |
8 | 7 |
|
9 | | -Building and distributing a release of Roundup is done by running: |
| 8 | +Roundup release checklist: |
10 | 9 |
|
11 | | -1. Make sure the unit tests run! "./run_tests.py" |
12 | | -2. Edit roundup/__init__.py, CHANGES.txt and doc/announcement.txt to |
13 | | - reflect the new version and appropriate announcements. |
14 | | -3. Note the date in the CHANGES.txt file. |
| 10 | +1. Run unit tests! They should pass successfully. "./run_tests.py" |
| 11 | +2. Change version in roundup/__init__.py, record date in CHANGES.txt. |
| 12 | +3. Update doc/announcement.txt with new details. |
15 | 13 | 4. Clean out all *.orig, *.rej, .#* files from the source. |
16 | 14 | 5. python setup.py clean --all |
17 | | -6. Edit setup.py to ensure that all information therein (version, contact |
18 | | - information etc) is correct. |
| 15 | +6. Edit setup.py to ensure that all information therein (contacts, |
| 16 | + classifiers, etc) is correct. |
19 | 17 | 7. python setup.py build_doc |
20 | 18 | 8. python setup.py sdist --manifest-only |
21 | 19 | 9. Check the MANIFEST to make sure that any new files are included. If |
|
0 commit comments