Skip to content

Commit 961d73b

Browse files
committed
Delete cut/paste command sequence; make commands more obvious
You couldn't actually cut/paste the commands as there were intemediate steps that had to be done. Moved commands into the release list. All commands are indented and surrounded by blank lines to make cutting/pasting easier.
1 parent 996c156 commit 961d73b

File tree

1 file changed

+38
-33
lines changed

1 file changed

+38
-33
lines changed

RELEASE.txt

Lines changed: 38 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,18 @@ Roundup release checklist:
1212
advance of the release to allow for translators to update their
1313
translations. Merge into .po files by running 'make *.po'
1414
in the locale directory. Run:
15+
1516
make template
1617
make *.po
18+
1719
2. Run unit tests! They should pass successfully. Install pytest
1820
using pip2/pip3 for python2 and python3. Then invoke pytest
1921
using both python versions from the top of the roundup tree:
22+
2023
python3 -m pytest test/
2124
python2 -m pytest test/
22-
3. Update version
25+
26+
3. Update version in:
2327
CHANGES.txt
2428
roundup/__init__.py
2529
website/www/index.txt
@@ -39,34 +43,54 @@ Roundup release checklist:
3943
beta alpha etc.
4044

4145
Check that metadata is valid and long descriptions is proper reST:
46+
4247
python setup.py check --restructuredtext --metadata --strict
48+
4349
6. Clean out all *.orig, *.rej, .#* files from the source.
44-
6a. Rebuild .mo translation files in distribution - cd locale; make
50+
51+
find . -name '*.orig' -exec rm {} \;
52+
find . -name '*.rej' -exec rm {} \;
53+
find . -name '.#*' -exec rm {} \;
54+
55+
6a. Rebuild .mo translation files in distribution
56+
57+
cd locale
58+
make
59+
cd ..
60+
4561
7. Remove previous build files
62+
4663
python setup.py clean --all
4764
rm -rf build/share # deletes locale .mo files
48-
Rebuild and install .mo files
49-
python setup.py build (sdist generation will fail if this isn't done)
50-
8. Check documentation:
51-
python setup.py check --restructuredtext --metadata --strict
52-
Rebuild documentation in "share/doc/roundup/html"
65+
66+
Build including new .mo files built in 6a.
67+
68+
python setup.py build
69+
70+
(sdist generation will fail if this isn't done)
71+
8. Rebuild documentation in "share/doc/roundup/html"
72+
5373
python setup.py build_doc
54-
9. python setup.py sdist
74+
75+
9. Generate source distribution:
76+
77+
python setup.py sdist
78+
5579
(if you find sdist a little verbose, add "--quiet" to the end of the
5680
command)
5781
9a. 2021/04/17 skip this for now. Need to make sure that whl installs
58-
execuable scripts properly and update these directions to test.
82+
exectuable scripts properly and update these directions to test.
5983

6084
python2 setup.py bdist_wheel; python3 setup.py bdist_wheel
6185

6286
to create binary distributions in wheel format. (egg format is
6387
deprecated.)
6488
10. Check the roundup.egg-info/SOURCES.txt to make sure that any new files are
6589
included. (use hg status --rev <last release or tag>:tip to list changed
66-
added and removed files. Last release e.g. 1.5.1 where tip was what would
90+
added and removed files. Last release e.g. 1.5.1 where tip is what would
6791
become 1.6) E.G.
6892

69-
hg status --rev 1.6.0:tip | sed -ne 's/^A //p' | while read i ; \
93+
hg status --rev 1.5.1:tip | sed -ne 's/^A //p' | while read i ; \
7094
do echo $i; grep "$i" roundup.egg-info/SOURCES.txt; done | uniq -c
7195

7296
Anything with a count of 1 is not in the manifest.
@@ -99,8 +123,9 @@ Roundup release checklist:
99123
Another way to do this is to use twine (pip install twine).
100124
You need to sign the tarball. This can be done with:
101125

126+
cd dist
102127
gpg --detach-sign --armor <filename>.tgz
103-
128+
104129
you should be prompted to use the roundup release key. If not you
105130
106131
This will create a file by the name <filename>.tgz.asc. Then
@@ -138,26 +163,7 @@ Roundup release checklist:
138163
released version (or at least the major non pre-release
139164
1.x/2.x version).
140165

141-
So, those commands in a nice, cut'n'pasteable form::
142-
143-
find . -name '*.orig' -exec rm {} \;
144-
find . -name '*.rej' -exec rm {} \;
145-
find . -name '.#*' -exec rm {} \;
146-
python setup.py clean --all
147-
python setup.py build
148-
python setup.py check --restructuredtext --metadata --strict
149-
python setup.py build_doc
150-
cd locale
151-
make
152-
cd ..
153-
python setup.py sdist --quiet
154-
## python setup.py bdist_rpm
155-
# not required for pypi.org since 2017 -> python setup.py register
156-
python setup.py sdist upload --repository pypi --sign
157-
158-
Note pypi no longer allows uploads of .exe installers such as produced
159-
by bdist_wininst. Removed directions for producing the binary
160-
distribution.
166+
-------------
161167

162168
If you get errors on the upload operation, you may need the following
163169
~/.pypirc file as well
@@ -178,4 +184,3 @@ repository: https://test.pypi.org/legacy/
178184
username: <your username on test.pypi.org here>
179185
password: <your password here>
180186
========
181-

0 commit comments

Comments
 (0)