Mercurial > p > roundup > code

annotate RELEASE.txt @ 6438:b671ed2b49b2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
2551143: Problem with installing external trackers ... the change from distutils to setuptools moved the directories for the templates, man pages and docs under the install directory. The install directory is buried in the directory tree under /usr/ib/python/.../roundup...egg/... This patch tries to put them under: the directory specified by --prefix argument the python platform library prefix that prefixes /lib in sysconfig.getpath('platlib') the directory returned by sys.prefix.
author John Rouillard <rouilj@ieee.org>
date Sat, 19 Jun 2021 14:22:36 -0400
parents 843a88670707
children 5296d27ac97c
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
6224
3cf5bcf2bb5c Update commands needed for locale updates.
John Rouillard <rouilj@ieee.org>
parents: 6137
diff changeset
16 make template
3cf5bcf2bb5c Update commands needed for locale updates.
John Rouillard <rouilj@ieee.org>
parents: 6137
diff changeset
17 make *.po
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
18
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
19 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
20 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
21 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
22
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
23 python3 -m pytest test/
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
24 python2 -m pytest test/
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
25
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
26 3. Update version in:
4815
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
27 CHANGES.txt
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
28 roundup/__init__.py
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5334
diff changeset
29 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
30 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
31 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
32 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
33 release, churn contributers etc.). (Use hg churn -c -r ####..####)
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
34 4. Update documentation
4815
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
35 doc/announcement.txt
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
36 doc/upgrading.txt
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
37 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
38 _tmp/linkcheck/output.txt
488d44cb42ef add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents: 5358
diff changeset
39 fix broken references in docs
488d44cb42ef add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents: 5358
diff changeset
40 verify redirects are correct
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
41 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
42 releasing check that Development Status matches release: stable,
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
43 beta alpha etc.
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
44
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
45 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
46
4835
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
47 python 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
48
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
49 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
50
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
51 find . -name '*.orig' -exec rm {} \;
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
52 find . -name '*.rej' -exec rm {} \;
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
53 find . -name '.#*' -exec rm {} \;
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 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
56
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
57 cd locale
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
58 make
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
59 cd ..
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
60
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
61 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
62
4835
5cd6b0014f34 RELEASE.txt: Do 'setup.py check -rms' command to validate that long
anatoly techtonik <techtonik@gmail.com>
parents: 4834
diff changeset
63 python setup.py clean --all
6225
043a8ffd79ad Commits for roundup 2.0 release.
John Rouillard <rouilj@ieee.org>
parents: 6224
diff changeset
64 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
65
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
66 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
67
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
68 python setup.py build
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 (sdist generation will fail if this isn't done)
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
71 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
72
4834
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
73 python setup.py build_doc
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
74
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
75 9. Generate source distribution:
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
76
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
77 python setup.py sdist
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
78
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
79 (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
80 command)
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
81 9a. 2021/04/17 skip this for now. Need to make sure that whl installs
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
82 exectuable 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
83
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
84 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
85
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
86 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
87 deprecated.)
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
88 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
89 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
90 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
91 become 1.6) E.G.
5951
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
92
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
93 hg status --rev 1.5.1:tip | sed -ne 's/^A //p' | while read i ; \
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
94 do echo $i; grep "$i" roundup.egg-info/SOURCES.txt; done | uniq -c
5951
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
95
6137
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
96 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
97 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
98 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
99 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
100 (Note: files under website/ shouldn't be in the manifest.)
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
101 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
102 file in /tmp then
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
103 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
104 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
105 b) demo.py
1947
0e19e99075e3 fix #white in cgitb
Richard Jones <richard@users.sourceforge.net>
parents: 1939
diff changeset
106 with all available Python versions.
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
107 11a. (TBD how to test wheel binary distribution before uploading.)
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
108 12. Assuming all is well 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
109 system.
adf1061f15a6 Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents: 5357
diff changeset
110 a) hg tag 1.6.0 # use right version. Should create/commit a changeset
adf1061f15a6 Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents: 5357
diff changeset
111 b) hg push # update main repo
adf1061f15a6 Update docs on how to tag with mercurial.
John Rouillard <rouilj@ieee.org>
parents: 5357
diff changeset
112 c) hg sum # verify that the tag shows up
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
113 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
114 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
115 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
116
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
117 python setup.py sdist upload --repository pypi --sign
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
118
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
119 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
120 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
121 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
122
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
123 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
124 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
125
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
126 cd dist
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
127 gpg --detach-sign --armor <filename>.tgz
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
128
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
129 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
130 can add --local=roundup-devel@lists.sourceforge.net.
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
131 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
132 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
133 at the same time. E.G.:x
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
134
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
135 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
136
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
137 (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
138 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
139 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
140 add `asc'.)
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
141
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
142 The distribution file should appear on
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
143 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
144 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
145 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
146 "--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
147
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
148 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
149 distributions (if created). Follow the directions for generating
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
150 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
151 signature files together.
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
152 14. Send doc/announcement.txt to python-announce@python.org and
4277
9e1a91f3cf17 - Add roundup-devel@lists.sourceforge.net to announcement list.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4272
diff changeset
153 roundup-users@lists.sourceforge.net and
9e1a91f3cf17 - Add roundup-devel@lists.sourceforge.net to announcement list.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4272
diff changeset
154 roundup-devel@lists.sourceforge.net
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
155 14b. Update entry on https://freshcode.club/projects/roundup-tracker
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
156 14c. Update entries for fossies by emailing announcement to
5776
bff95a7bcdbc Add some additional sites to update with release announcements:
John Rouillard <rouilj@ieee.org>
parents: 5520
diff changeset
157 announce@fossies.org
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
158 15. Refresh website.
4836
fdcd7ef5bacf RELEASE.txt: +website update
anatoly techtonik <techtonik@gmail.com>
parents: 4835
diff changeset
159 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
160 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
161 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
162 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
163 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
164 1.x/2.x version).
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
165
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
166 -------------
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
167
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
168 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
169 ~/.pypirc file as well
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
170
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
171 ========
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
172 [distutils]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
173 index-servers =
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
174 test
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
175 pypi
4501
588e5dbbb9fe - document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4487
diff changeset
176
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
177 [pypi]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
178 repository: https://upload.pypi.org/legacy/
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
179 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
180 password: <your password here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
181
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
182 [test]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
183 repository: https://test.pypi.org/legacy/
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
184 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
185 password: <your password here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
186 ========
Roundup Issue Tracker: http://roundup-tracker.org/