Mercurial > p > roundup > code

annotate RELEASE.txt @ 6806:bdd28b244839

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- issue2551223 - fix timestamp truncation in mysql and postgresql The data types used to represent timestamps in pg and mysql for ephemeral tables: sessions and otks don't have enough signifcant digits to work. As a result the timestamps are rounduped (up/down) rsuling in the stored timestamp being 2 minutes (pg) or 2-3 hours(mysql) off from what it should be. Modify db schema to use a numeric type that preserves more significant figures. Implement schema upgrade. Document need for upgrade in upgrading.txt. Write tests for schema upgrade. Implement test for updateTimestamp method on BasicDatabase that showed this issue in the first place. Write overrides for test for anydbm/memorydb which store timestamp properly or not at all.
author John Rouillard <rouilj@ieee.org>
date Mon, 25 Jul 2022 17:20:20 -0400
parents a1868fe784d0
children d7905a78ab8a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1354
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
1 Building Releases
f79ed90ccecf cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 518
diff changeset
2 =================
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3
4807
641f0895d306 Revise BUILD.txt
anatoly techtonik <techtonik@gmail.com>
parents: 4798
diff changeset
4 Roundup is a pure Python application with no binary components. This file
641f0895d306 Revise BUILD.txt
anatoly techtonik <techtonik@gmail.com>
parents: 4798
diff changeset
5 describes how to build a source release. To find out how to install
641f0895d306 Revise BUILD.txt
anatoly techtonik <techtonik@gmail.com>
parents: 4798
diff changeset
6 Roundup, read the doc/installation.txt file.
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7
4807
641f0895d306 Revise BUILD.txt
anatoly techtonik <techtonik@gmail.com>
parents: 4798
diff changeset
8 Roundup release checklist:
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
10 1. Regenerate locale/roundup.pot. See "Extracting Translatable
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
11 Messages" in doc/developers.txt. This is best done some time in
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
12 advance of the release to allow for translators to update their
5841
f2804ec3bd06 issue2551007 document merging .pot files into .po file and
John Rouillard <rouilj@ieee.org>
parents: 5835
diff changeset
13 translations. Merge into .po files by running 'make *.po'
6224
3cf5bcf2bb5c Update commands needed for locale updates.
John Rouillard <rouilj@ieee.org>
parents: 6137
diff changeset
14 in the locale directory. Run:
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
15
6453
3e7fc096fe5b add cd commands for better cut/paste.
John Rouillard <rouilj@ieee.org>
parents: 6451
diff changeset
16 cd locale
6224
3cf5bcf2bb5c Update commands needed for locale updates.
John Rouillard <rouilj@ieee.org>
parents: 6137
diff changeset
17 make template
3cf5bcf2bb5c Update commands needed for locale updates.
John Rouillard <rouilj@ieee.org>
parents: 6137
diff changeset
18 make *.po
6453
3e7fc096fe5b add cd commands for better cut/paste.
John Rouillard <rouilj@ieee.org>
parents: 6451
diff changeset
19 cd ..
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
20
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
21 2. Run unit tests! They should pass successfully. Install pytest
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
22 using pip2/pip3 for python2 and python3. Then invoke pytest
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
23 using both python versions from the top of the roundup tree:
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
24
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
25 python3 -m pytest test/
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
26 python2 -m pytest test/
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
27
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
28 3. Update version in:
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
29 CHANGES.txt (set date for version as well)
4815
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
30 roundup/__init__.py
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5334
diff changeset
31 website/www/index.txt
5345
9e2f5a615eca website/www/conf.py needs copyright update and version update.
John Rouillard <rouilj@ieee.org>
parents: 5337
diff changeset
32 website/www/conf.py (also update copyright)
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
33 3a. Update license end date in COPYING.txt
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
34 3b. Update doc/acknowledgements.txt (add section for
5835
ad5cae31cd0f Fix typos and add build step.
John Rouillard <rouilj@ieee.org>
parents: 5776
diff changeset
35 release, churn contributers etc.). (Use hg churn -c -r ####..####)
6697
ff0b3402fa73 add blank line to separate section.
John Rouillard <rouilj@ieee.org>
parents: 6695
diff changeset
36
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
37 4. Update documentation
4815
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
38 doc/announcement.txt
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
39 doc/upgrading.txt
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
40 4a. cd to website/www and run 'make linkcheck'. See output in
5374
488d44cb42ef add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents: 5358
diff changeset
41 _tmp/linkcheck/output.txt
488d44cb42ef add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents: 5358
diff changeset
42 fix broken references in docs
488d44cb42ef add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents: 5358
diff changeset
43 verify redirects are correct
6697
ff0b3402fa73 add blank line to separate section.
John Rouillard <rouilj@ieee.org>
parents: 6695
diff changeset
44
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
45 5. Update setup.py info if needed (contacts, classifiers, etc.). When
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
46 releasing check that Development Status matches release: stable,
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
47 beta alpha etc.
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
48
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
49 Check that metadata is valid and long descriptions is proper reST:
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
50
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
51 python3 setup.py check --restructuredtext --metadata --strict
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
52
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
53 6. Clean out all *.orig, *.rej, .#* files from the source.
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
54
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
55 find . -name '*.orig' -exec rm {} \;
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
56 find . -name '*.rej' -exec rm {} \;
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
57 find . -name '.#*' -exec rm {} \;
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
58
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
59 6a. Rebuild .mo translation files in distribution
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
60
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
61 cd locale
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
62 make
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
63 cd ..
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
64
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
65 7. Remove previous build files
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
66
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
67 python3 setup.py clean --all
6225
043a8ffd79ad Commits for roundup 2.0 release.
John Rouillard <rouilj@ieee.org>
parents: 6224
diff changeset
68 rm -rf build/share # deletes locale .mo files
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
69
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
70 Build including new .mo files built in 6a.
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
71
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
72 python3 setup.py build
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
73
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
74 (sdist generation will fail if this isn't done)
6697
ff0b3402fa73 add blank line to separate section.
John Rouillard <rouilj@ieee.org>
parents: 6695
diff changeset
75
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
76 8. Rebuild documentation in "share/doc/roundup/html"
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
77
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
78 python3 setup.py build_doc
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
79
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
80 9. Generate source distribution:
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
81
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
82 python3 setup.py sdist
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
83
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
84 (if you find sdist a little verbose, add "--quiet" to the end of the
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
85 command)
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
86 9a. 2021/04/17 skip this for now. Need to make sure that whl installs
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
87 executable scripts properly and update these directions to test.
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
88
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
89 python2 setup.py bdist_wheel; python3 setup.py bdist_wheel
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
90
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
91 to create binary distributions in wheel format. (egg format is
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
92 deprecated.)
6695
b3ba03d2b214 2.2.0b1 release changes
John Rouillard <rouilj@ieee.org>
parents: 6685
diff changeset
93
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
94 10. Check the roundup.egg-info/SOURCES.txt to make sure that any new files are
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
95 included. (use hg status --rev <last release or tag>:tip to list changed
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
96 added and removed files. Last release e.g. 1.5.1 where tip is what would
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
97 become 1.6) E.G.
5951
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
98
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
99 hg status --rev 2.0.0:tip | sed -ne 's/^A //p' | while read i ; \
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
100 do echo $i; grep "$i" roundup.egg-info/SOURCES.txt; done | \
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
101 uniq -c | sort -rn
5951
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
102
6137
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
103 Anything with a count of 1 is not in the manifest.
6225
043a8ffd79ad Commits for roundup 2.0 release.
John Rouillard <rouilj@ieee.org>
parents: 6224
diff changeset
104 If there are missing files that should be in the manifest,
6137
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
105 edit MANIFEST.in to include them. For format docs see
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
106 https://packaging.python.org/guides/using-manifest-in/#using-manifest-in
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
107 (Note: files under website/ shouldn't be in the manifest.)
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
108 10a: Check for removed files still in manifest:
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
109
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
110 hg status --rev 2.0.0:tip | sed -ne 's/^R //p' | while read i ; \
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
111 do echo $i; grep "$i" roundup.egg-info/SOURCES.txt; done | \
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
112 uniq -c | sort -n
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
113
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
114 any file with a count of 2 or more needs to be removed from
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
115 MANIFEST.in and possibly cleaned out of the build tree.
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
116 10b: if you added/removed files rebuild starting at step 6a.
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
117
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
118 11. Unpack the new tarball created in dist/roundup-<version>.tar.gz
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
119 file in /tmp then
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
120 a) run tests using installed pytest run under python2 and
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
121 python3. (python2 -m pytest test/; python3 -m pytest test/)
4834
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
122 b) demo.py
1947
0e19e99075e3 fix #white in cgitb
Richard Jones <richard@users.sourceforge.net>
parents: 1939
diff changeset
123 with all available Python versions.
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
124 11a. (TBD how to test wheel binary distribution before uploading.)
6697
ff0b3402fa73 add blank line to separate section.
John Rouillard <rouilj@ieee.org>
parents: 6695
diff changeset
125
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
126 12. Assuming all is well commit and tag the release in the version-control
5358
adf1061f15a6 Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents: 5357
diff changeset
127 system.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
128 a) hg commit ... # commit any edits from steps 1-5
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
129 b) hg tag 2.1.0 # use right version. Should create/commit a changeset
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
130 c) hg push # update main repo
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
131 d) hg sum # verify that the tag shows up
6697
ff0b3402fa73 add blank line to separate section.
John Rouillard <rouilj@ieee.org>
parents: 6695
diff changeset
132
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
133 13. Upload source distribution to PyPI - requires you sign up for a
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
134 pypi account and be added as a maintainer to roundup. Ask existing
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
135 maintainer for access. You can do this two ways:
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
136
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
137 python3 setup.py sdist upload --repository pypi --sign
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
138
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
139 which rebuilds the source distribution tarball and uploads it.
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
140 This means that you have uploaded something tha is not tested. It
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
141 should be the same as the tarball you tested but....
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
142
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
143 Another way to do this is to use twine (pip install twine).
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
144 You need to sign the tarball. This can be done with:
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
145
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
146 cd dist
6685
6d102b4ba4d7 Add explicit keyid for signing.
John Rouillard <rouilj@ieee.org>
parents: 6455
diff changeset
147 gpg --detach-sign --armor -u 1F2DD0CB756A76D8 <filename>.tgz
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
148
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
149 you should be prompted to use the roundup release key. If not you
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
150 can add --local=roundup-devel@lists.sourceforge.net.
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
151 This will create a file by the name <filename>.tgz.asc. Then
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
152 use twine to upload *both* the asc and distibution tarball
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
153 at the same time. E.G.:x
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
154
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
155 twine upload --repository pypi <filename>.tar.gz <filename>.tar.gz.asc
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
156
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
157 (If you upload the .asc file separately from the distibution file
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
158 it gets a different path and is not able to be located in the pypi
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
159 interface. The asc file is downloaded using the tarball path and
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
160 add `asc'.)
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
161
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
162 The distribution file should appear on
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
163 https://pypi.python.org/pypi/roundup in no time. If you are using
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
164 python older than 2.7.13 you need a .pypirc shown below since the
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
165 URL has changed. If using 2.7.13 or newer, you can remove the
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
166 "--repository pypi" option and use 'setup.py sdist upload...'.
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
167
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
168 You can also use twine to upload the .whl (wheel) format
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
169 distributions (if created). Follow the directions for generating
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
170 the gpg asc files and upload the .whl distribution and .whl.asc
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
171 signature files together.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
172
6748
647f806d54b8 Change order of ops website then notices; additional web pages
John Rouillard <rouilj@ieee.org>
parents: 6697
diff changeset
173 14. Refresh website.
4836
fdcd7ef5bacf RELEASE.txt: +website update
anatoly techtonik <techtonik@gmail.com>
parents: 4835
diff changeset
174 website/README.txt
6265
b2eb59ada444 Replace http:....roundup-tracker.org with https. Also fix wiki links.
John Rouillard <rouilj@ieee.org>
parents: 6225
diff changeset
175 https://www.roundup-tracker.org/ should state that the stable
5148
71643a839c80 Updated release docs to account for issue2550838.
John Rouillard <rouilj@ieee.org>
parents: 5144
diff changeset
176 version is the one that you released.
6265
b2eb59ada444 Replace http:....roundup-tracker.org with https. Also fix wiki links.
John Rouillard <rouilj@ieee.org>
parents: 6225
diff changeset
177 https://www.roundup-tracker.org/docs.html should also match the
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
178 released version (or at least the major non pre-release
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
179 1.x/2.x version).
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
180
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
181 15. Send doc/announcement.txt to python-announce@python.org,
6748
647f806d54b8 Change order of ops website then notices; additional web pages
John Rouillard <rouilj@ieee.org>
parents: 6697
diff changeset
182 roundup-users@lists.sourceforge.net,
647f806d54b8 Change order of ops website then notices; additional web pages
John Rouillard <rouilj@ieee.org>
parents: 6697
diff changeset
183 roundup-devel@lists.sourceforge.net, and lwn@lwn.net.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
184 15b. Update entry on https://freshcode.club/projects/roundup-tracker
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
185 15c. Update entries for fossies by emailing announcement to
6748
647f806d54b8 Change order of ops website then notices; additional web pages
John Rouillard <rouilj@ieee.org>
parents: 6697
diff changeset
186 announce@fossies.org
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
187 15d. Update entry on https://directory.fsf.org/wiki/Roundup.
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
188
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
189 16. Change the release version on the GitHub section at
6748
647f806d54b8 Change order of ops website then notices; additional web pages
John Rouillard <rouilj@ieee.org>
parents: 6697
diff changeset
190 https://wiki.roundup-tracker.org/CiTestingEnvironment
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
191 16b. Update release info on wikipedia:
6748
647f806d54b8 Change order of ops website then notices; additional web pages
John Rouillard <rouilj@ieee.org>
parents: 6697
diff changeset
192 https://en.wikipedia.org/wiki/Roundup_(issue_tracker)
647f806d54b8 Change order of ops website then notices; additional web pages
John Rouillard <rouilj@ieee.org>
parents: 6697
diff changeset
193
647f806d54b8 Change order of ops website then notices; additional web pages
John Rouillard <rouilj@ieee.org>
parents: 6697
diff changeset
194 https://en.wikipedia.org/wiki/Comparison_of_issue-tracking_systems
647f806d54b8 Change order of ops website then notices; additional web pages
John Rouillard <rouilj@ieee.org>
parents: 6697
diff changeset
195
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
196
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
197 -------------
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
198
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
199 If you get errors on the upload operation, you may need the following
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
200 ~/.pypirc file as well
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
201
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
202 ========
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
203 [distutils]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
204 index-servers =
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
205 test
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
206 pypi
4501
588e5dbbb9fe - document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4487
diff changeset
207
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
208 [pypi]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
209 repository: https://upload.pypi.org/legacy/
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
210 username: <your username on pypi.org here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
211 password: <your password here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
212
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
213 [test]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
214 repository: https://test.pypi.org/legacy/
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
215 username: <your username on test.pypi.org here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
216 password: <your password here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
217 ========
Roundup Issue Tracker: http://roundup-tracker.org/