Mercurial > p > roundup > code

annotate RELEASE.txt @ 8513:d7d91e25a1c2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
chore(build): bump anchore/scan-action from 7.2.3 to 7.3.0 pull #80
author John Rouillard <rouilj@ieee.org>
date Tue, 27 Jan 2026 21:41:37 -0500
parents c7a2e01793cd
children
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
7423
f6bad20ef102 Document use of new make merge.
John Rouillard <rouilj@ieee.org>
parents: 7227
diff changeset
17 make merge
6453
3e7fc096fe5b add cd commands for better cut/paste.
John Rouillard <rouilj@ieee.org>
parents: 6451
diff changeset
18 cd ..
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
19
7423
f6bad20ef102 Document use of new make merge.
John Rouillard <rouilj@ieee.org>
parents: 7227
diff changeset
20 'make merge' will remake template if the source and html files are
f6bad20ef102 Document use of new make merge.
John Rouillard <rouilj@ieee.org>
parents: 7227
diff changeset
21 out of date. 'make template' will regenerate roundup.pot. Touch
f6bad20ef102 Document use of new make merge.
John Rouillard <rouilj@ieee.org>
parents: 7227
diff changeset
22 any .py file in the roundup/ directory to force 'make template'
f6bad20ef102 Document use of new make merge.
John Rouillard <rouilj@ieee.org>
parents: 7227
diff changeset
23 to run.
f6bad20ef102 Document use of new make merge.
John Rouillard <rouilj@ieee.org>
parents: 7227
diff changeset
24
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
25 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
26 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
27 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
28
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
29 python3 -m pytest test/
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
30 python2 -m pytest test/
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
31
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
32 3. Update version in:
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
33 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
34 roundup/__init__.py
7468
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7435
diff changeset
35 website/www/index.txt (current stable version, release highlights)
7529
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
36 website/www/conf.py (update copyright, version auto-set from
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
37 roundup/__init__.py)
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
38 scripts/Docker/Dockerfile update value of
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
39 org.opencontainers.image.version
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
40 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
41 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
42 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
43
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
44 4. Update documentation
4815
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
45 doc/announcement.txt
efa61cc8be67 RELEASE.txt: doc/upgrading.txt needs to be updated too
anatoly techtonik <techtonik@gmail.com>
parents: 4809
diff changeset
46 doc/upgrading.txt
7941
d272c828d376 doc: add sed command to extract number of changes in a release.
John Rouillard <rouilj@ieee.org>
parents: 7939
diff changeset
47
d272c828d376 doc: add sed command to extract number of changes in a release.
John Rouillard <rouilj@ieee.org>
parents: 7939
diff changeset
48 Use::
d272c828d376 doc: add sed command to extract number of changes in a release.
John Rouillard <rouilj@ieee.org>
parents: 7939
diff changeset
49
d272c828d376 doc: add sed command to extract number of changes in a release.
John Rouillard <rouilj@ieee.org>
parents: 7939
diff changeset
50 sed -ne '/^20[0-9][0-9]-XX/,/^202[0-9]-/{/^-/p}' CHANGES.txt | wc -l
d272c828d376 doc: add sed command to extract number of changes in a release.
John Rouillard <rouilj@ieee.org>
parents: 7939
diff changeset
51
d272c828d376 doc: add sed command to extract number of changes in a release.
John Rouillard <rouilj@ieee.org>
parents: 7939
diff changeset
52 to get number of features/fixes included in the release.
d272c828d376 doc: add sed command to extract number of changes in a release.
John Rouillard <rouilj@ieee.org>
parents: 7939
diff changeset
53
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
54 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
55 _tmp/linkcheck/output.txt
488d44cb42ef add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents: 5358
diff changeset
56 fix broken references in docs
488d44cb42ef add running linkcheck to update docs
John Rouillard <rouilj@ieee.org>
parents: 5358
diff changeset
57 verify redirects are correct
6697
ff0b3402fa73 add blank line to separate section.
John Rouillard <rouilj@ieee.org>
parents: 6695
diff changeset
58
7962
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7941
diff changeset
59 Use::
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7941
diff changeset
60
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7941
diff changeset
61 grep '\[broken\]\s*htt' _tmp/linkcheck/output.txt
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7941
diff changeset
62
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7941
diff changeset
63 to find external refs only. Internal refs will probably fail
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7941
diff changeset
64 because they don't use :ref: or :doc: roles to reference them.
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7941
diff changeset
65 They are referenced using html link syntax.
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7941
diff changeset
66
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
67 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
68 releasing check that Development Status matches release: stable,
8069
4f07d7835019 build: some work from RELEASE.txt for 2.4.0 release.
John Rouillard <rouilj@ieee.org>
parents: 8050
diff changeset
69 beta, alpha etc.
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
70
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5841
diff changeset
71 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
72
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
73 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
74
8382
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
75 6. Rebuild .mo translation files in distribution
6379
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 cd locale
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
78 make
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
79 cd ..
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
80
5520
0036f4a7bf2a Mention regenerating roundup.pot in release instructions.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5374
diff changeset
81 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
82
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
83 python3 setup.py clean --all
6225
043a8ffd79ad Commits for roundup 2.0 release.
John Rouillard <rouilj@ieee.org>
parents: 6224
diff changeset
84 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
85
8382
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
86 Clean out all *.orig, *.rej, .#* files from the source.
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
87
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
88 find . -name '*.orig' -exec rm {} \;
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
89 find . -name '*.rej' -exec rm {} \;
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
90 find . -name '.#*' -exec rm {} \;
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
91
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
92 7a.
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
93
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
94 Build including new .mo files built in 6.
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
95
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
96 python3 setup.py build
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
97
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
98 (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
99
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
100 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
101
8330
3283f30623d0 docs: update using make to generate docs for the release tarball
John Rouillard <rouilj@ieee.org>
parents: 8079
diff changeset
102 cd doc
3283f30623d0 docs: update using make to generate docs for the release tarball
John Rouillard <rouilj@ieee.org>
parents: 8079
diff changeset
103 make
8382
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
104 cd ..
8330
3283f30623d0 docs: update using make to generate docs for the release tarball
John Rouillard <rouilj@ieee.org>
parents: 8079
diff changeset
105
3283f30623d0 docs: update using make to generate docs for the release tarball
John Rouillard <rouilj@ieee.org>
parents: 8079
diff changeset
106 runs commands to turn man pages into html files and adds them to
3283f30623d0 docs: update using make to generate docs for the release tarball
John Rouillard <rouilj@ieee.org>
parents: 8079
diff changeset
107 html_extra/man_pages subdir. Then it generates html text from
3283f30623d0 docs: update using make to generate docs for the release tarball
John Rouillard <rouilj@ieee.org>
parents: 8079
diff changeset
108 running roundup_admin. Then it generates a current copy of a
3283f30623d0 docs: update using make to generate docs for the release tarball
John Rouillard <rouilj@ieee.org>
parents: 8079
diff changeset
109 config.ini file. Then it runs:
3283f30623d0 docs: update using make to generate docs for the release tarball
John Rouillard <rouilj@ieee.org>
parents: 8079
diff changeset
110
3283f30623d0 docs: update using make to generate docs for the release tarball
John Rouillard <rouilj@ieee.org>
parents: 8079
diff changeset
111 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
112
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
113 9. Generate source distribution:
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
114
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
115 python3 setup.py sdist
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
116
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
117 (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
118 command)
8382
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
119
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
120 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
121 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
122
8382
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
123 python3 setup.py bdist_wheel
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
124
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
125 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
126 deprecated.)
6695
b3ba03d2b214 2.2.0b1 release changes
John Rouillard <rouilj@ieee.org>
parents: 6685
diff changeset
127
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
128 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
129 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
130 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
131 become 1.6) E.G.
5951
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
132
7530
ed2bc951277b Updates for 2.3.0 release.
John Rouillard <rouilj@ieee.org>
parents: 7529
diff changeset
133 hg status --rev 2.2.0:tip | sed -ne 's/^A //p' | while read i ; \
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
134 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
135 uniq -c | sort -rn
5951
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
136
6137
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
137 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
138 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
139 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
140 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
141 (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
142 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
143
7530
ed2bc951277b Updates for 2.3.0 release.
John Rouillard <rouilj@ieee.org>
parents: 7529
diff changeset
144 hg status --rev 2.2.0:tip | sed -ne 's/^R //p' | while read i ; \
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
145 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
146 uniq -c | sort -n
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
147
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
148 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
149 MANIFEST.in and possibly cleaned out of the build tree.
8382
109c1112c329 build: instruction updates/reorder
John Rouillard <rouilj@ieee.org>
parents: 8378
diff changeset
150
6451
bb561a8b179f python -> python3, check removed files; baseline from 2.0.0
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
151 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
152
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
153 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
154 file in /tmp then
8378
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
155 a) run tests using installed pytest run under
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
156 python3. (python3 -m pytest test/)
4834
8a4021713c6e RELEASE: Add PyPI page review to the checklist.
anatoly techtonik <techtonik@gmail.com>
parents: 4815
diff changeset
157 b) demo.py
8378
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
158 with all available Python 3 versions.
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
159 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
160
7529
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
161 11b. Generate GPG signature file
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
162
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
163 cd dist
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
164 gpg --detach-sign --armor -u 1F2DD0CB756A76D8 <filename>.tar.gz
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
165
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
166 you should be prompted to use the roundup release key. If not you
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
167 can add --local=roundup-devel@lists.sourceforge.net.
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
168 This will create a file by the name <filename>.tar.gz.asc.
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
169
8395
c7a2e01793cd build: 2.5.0 release checkin. Tag to come.
John Rouillard <rouilj@ieee.org>
parents: 8382
diff changeset
170 Move file to website/www/signatures directory
7529
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
171
8076
9ffb6cff2859 docs: spelling fix
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
172 mv <filename>.tar.gz.asc ../website/www/signatures/.
8395
c7a2e01793cd build: 2.5.0 release checkin. Tag to come.
John Rouillard <rouilj@ieee.org>
parents: 8382
diff changeset
173 hg add ../website/www/signatures/<filename>.tar.gz.asc
7529
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
174 # commiting the file will be done in step 12
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
175 cd ..
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
176
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
177 Add a link to the signature to doc/security.txt. Add a new link
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
178 to the start of the signature list in doc/security.txt (look for
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
179 the word multicol).
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
180
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
181 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
182 system.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
183 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
184 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
185 c) hg push # update main repo
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
186 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
187
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
188 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
189 pypi account and be added as a maintainer to roundup. Ask existing
7529
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
190 maintainer for access. Do this using twine (pip install twine).
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
191
7428
186956a87ad7 issue2551279 - GPG support removed from pypi - rewrite pgp signature validation.
John Rouillard <rouilj@ieee.org>
parents: 7423
diff changeset
192 The original directions used twine to upload the tarball and the
186956a87ad7 issue2551279 - GPG support removed from pypi - rewrite pgp signature validation.
John Rouillard <rouilj@ieee.org>
parents: 7423
diff changeset
193 signature, but as of May 2023, PyPI no longer accepts signature
7529
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
194 files. So we publish the signature as part of the website.
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
195
7428
186956a87ad7 issue2551279 - GPG support removed from pypi - rewrite pgp signature validation.
John Rouillard <rouilj@ieee.org>
parents: 7423
diff changeset
196 Use twine to upload the distribution tarball. E.G.
186956a87ad7 issue2551279 - GPG support removed from pypi - rewrite pgp signature validation.
John Rouillard <rouilj@ieee.org>
parents: 7423
diff changeset
197
186956a87ad7 issue2551279 - GPG support removed from pypi - rewrite pgp signature validation.
John Rouillard <rouilj@ieee.org>
parents: 7423
diff changeset
198 twine upload --repository pypi <filename>.tar.gz
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
199
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
200 The distribution file should appear on
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
201 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
202 python older than 2.7.13 you need a .pypirc shown below since the
7428
186956a87ad7 issue2551279 - GPG support removed from pypi - rewrite pgp signature validation.
John Rouillard <rouilj@ieee.org>
parents: 7423
diff changeset
203 URL has changed.
6378
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
204
b57c3d50505b issue2550899 Migrate setup.py to setuptools
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
205 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
206 distributions (if created). Follow the directions for generating
7428
186956a87ad7 issue2551279 - GPG support removed from pypi - rewrite pgp signature validation.
John Rouillard <rouilj@ieee.org>
parents: 7423
diff changeset
207 the gpg asc files and place the .whl.asc in the signature
186956a87ad7 issue2551279 - GPG support removed from pypi - rewrite pgp signature validation.
John Rouillard <rouilj@ieee.org>
parents: 7423
diff changeset
208 directory.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
209
7529
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
210 Another way to upload is to use:
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
211
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
212 python3 setup.py sdist upload --repository pypi
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
213
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
214 BUT this rebuilds the source distribution tarball and uploads it.
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
215 This means that you have uploaded something that is not tested.
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
216 Also the metadata in the file changes and will not match the GPG
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
217 signature you commited in step 12. So use twine.
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
218
6748
647f806d54b8 Change order of ops website then notices; additional web pages
John Rouillard <rouilj@ieee.org>
parents: 6697
diff changeset
219 14. Refresh website.
4836
fdcd7ef5bacf RELEASE.txt: +website update
anatoly techtonik <techtonik@gmail.com>
parents: 4835
diff changeset
220 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
221 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
222 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
223 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
224 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
225 1.x/2.x version).
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
226
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
227 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
228 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
229 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
230 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
231 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
232 announce@fossies.org
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
233 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
234
8079
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
235 16. Change the version in the URL that generates the "commits since
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
236 release ...." badge. Also update Python test versions in the
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
237 GitHub Actions section at:
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
238 https://wiki.roundup-tracker.org/CiTestingEnvironment
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6748
diff changeset
239 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
240 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
241
647f806d54b8 Change order of ops website then notices; additional web pages
John Rouillard <rouilj@ieee.org>
parents: 6697
diff changeset
242 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
243
6812
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
244 17 Push release docker image to dockerhub
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
245 17a. install docker
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
246 17b. run: (issues, how to release a version e.g. to update alpine for
7120
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
247 security issues. Currently thinking that release tag is
8079
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
248 rounduptracker/roundup:2.4.0-1, -2 etc. Then add a tag
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
249 rounduptracker/roundup:2.4.0 that moves to always tag
7529
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
250 the latest -N release. Also roundup:latest points to the
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
251 newest -N for the newest roundup version.)
6812
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
252
8079
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
253 docker build -t rounduptracker/roundup:2.4.0 \
7049
a6526afd7c71 update commands for easier cut/paste.
John Rouillard <rouilj@ieee.org>
parents: 6812
diff changeset
254 --build-arg="source=pypi" -f scripts/Docker/Dockerfile .
6812
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
255
8079
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
256 to create the docker image. *Change 2.4.0 to current version*
6812
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
257 Always use the exact release tag.
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
258 17c. vulnerability scan local image using:
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
259
7049
a6526afd7c71 update commands for easier cut/paste.
John Rouillard <rouilj@ieee.org>
parents: 6812
diff changeset
260 docker run --rm --volume \
6812
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
261 /var/run/docker.sock:/var/run/docker.sock \
8079
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
262 --name Grype anchore/grype:latest rounduptracker/roundup:2.4.0
6812
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
263
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
264 should report no vulnerabilities (note match version with current
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
265 build)
7120
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
266
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
267 Also can scan (optionally) using trivy:
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
268
7671
2fc2b14edbf7 doc: add -it to docker command for running trivy
John Rouillard <rouilj@ieee.org>
parents: 7530
diff changeset
269 docker run -it --rm --volume \
7120
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
270 /var/run/docker.sock:/var/run/docker.sock \
7939
383560895329 test: update trivy options ignore-unifixed and exit-code 1
John Rouillard <rouilj@ieee.org>
parents: 7671
diff changeset
271 --name trivy aquasec/trivy:latest image --exit-code 1 \
8079
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
272 --ignore-unfixed rounduptracker/roundup:2.4.0
7120
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
273
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
274 You may need to explicitly update/refresh the scanners with:
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
275 "docker pull anchore/grype:latest" and similarly for
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
276 aquasec/trivy if used.
8378
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
277
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
278 Note that some security issues may show up. If they are in the
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
279 underlying OS package we can't do anything but make sure the
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
280 latest python:3-alpine package is used to build the image. Look
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
281 at the index digest on the image release page and compare it to
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
282 the sha256 at the top of the Dockerfile.
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
283
6812
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
284 17d. test roundup in demo mode:
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
285
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
286 docker run -it --rm -p 8917:8080 \
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
287 -v $PWD/tracker:/usr/src/app/tracker \
8079
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
288 rounduptracker/roundup:2.4.0 demo
7120
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
289
8378
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
290 FIXME: right now the external port number (8917) in the above
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
291 command is hardcoded in DOCKER. It can be overridden usng
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
292 PORT_8080=9017 for example. However the host is always
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
293 localhost. Consider replacing PORT_8080 with ORIGIN="host:port"
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
294 or ORIGIN="port" so that the web URL can be made correct when
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
295 running docker on a remote server.
118897c90d4e build: remove python 2.x directions; other notes/clarifications
John Rouillard <rouilj@ieee.org>
parents: 8330
diff changeset
296
6812
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
297 17e. push to DockerHub login (login using 'docker login <username>'
7120
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
298 first and user must be member of rounduptracker org with ability
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
299 to publish). Replace -N with the release number (e.g. -1, -2, -3...)
6812
d7905a78ab8a Add item to push docker image post release.
John Rouillard <rouilj@ieee.org>
parents: 6782
diff changeset
300
8079
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
301 docker tag rounduptracker/roundup:2.4.0 roundup-tracker/roundup:latest
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
302 docker tag rounduptracker/roundup:2.4.0 roundup-tracker/roundup:2.4.0-N
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
303 docker push rounduptracker/roundup:2.4.0
e3c5f85af7d5 docs: update release notes.
John Rouillard <rouilj@ieee.org>
parents: 8076
diff changeset
304 docker push rounduptracker/roundup:2.4.0-N
7120
06305faf0332 Update docker release instructions.
John Rouillard <rouilj@ieee.org>
parents: 7049
diff changeset
305 docker push rounduptracker/roundup # update roundup:latest
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
306
6379
843a88670707 Delete cut/paste command sequence; make commands more obvious
John Rouillard <rouilj@ieee.org>
parents: 6378
diff changeset
307 -------------
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
308
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
309 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
310 ~/.pypirc file as well
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
311
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
312 ========
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
313 [distutils]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
314 index-servers =
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
315 test
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
316 pypi
4501
588e5dbbb9fe - document experience from release(s)
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4487
diff changeset
317
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
318 [pypi]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
319 repository: https://upload.pypi.org/legacy/
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
320 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
321 password: <your password here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
322
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
323 [test]
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
324 repository: https://test.pypi.org/legacy/
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
325 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
326 password: <your password here>
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
327 ========
7227
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
328
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
329 -------------
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
330
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
331 ==========================
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
332 GPG public key operations.
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
333 ==========================
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
334
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
335 LIST IN KEYRING
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
336 ===============
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
337
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
338 $ gpg --list-keys -a roundup-devel@lists.sourceforge.net
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
339
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
340 pub rsa4096 2018-07-11 [SC] [expires: 2028-07-17]
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
341 411E354B5D1AF26125D621221F2DD0CB756A76D8
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
342 uid [ultimate] Roundup Team (signing key for roundup
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
343 releases) <roundup-devel@lists.sourceforge.net>
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
344 sub rsa4096 2018-07-11 [E] [expires: 2028-07-17]
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
345
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
346 EXTEND EXPIRATION DATE
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
347 ======================
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
348
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
349 Needs private key and passphrse for private key
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
350
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
351 $ gpg --edit-key 411E354B5D1AF26125D621221F2DD0CB756A76D8
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
352
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
353 > expire
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
354 [add some number of months/years to it]
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
355 > key 1
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
356 [ this chooses the subkey "sub" ]
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
357 > expire
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
358 [add some number of months/years to the sub key ]
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
359 > save
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
360 [ saves both keys, will need the private key and passphrase ]
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
361
7529
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
362 EXPORT NEW PUBLIC KEY
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
363 =====================
7227
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
364
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
365 $ gpg --export -a roundup-devel@lists.sourceforge.net >> \
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
366 tools/roundup.public.pgp.key
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
367
7529
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
368 then edit roundup.public.pgp.key keeping only the last key that starts
7227
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
369 with: -----BEGIN PGP PUBLIC KEY BLOCK-----
1e004afe87bb Update expiration date for gpg release signing key to 2028-07-17.
John Rouillard <rouilj@ieee.org>
parents: 7120
diff changeset
370
7529
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
371 and add back the preamble that describes where to find doc for
05448536f154 Update for release.
John Rouillard <rouilj@ieee.org>
parents: 7495
diff changeset
372 it. Commmit new key to mercurial.
8050
093d2e0761d4 docs: add directions on saving the key to the pgp.mit.edu keyserver
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
373
093d2e0761d4 docs: add directions on saving the key to the pgp.mit.edu keyserver
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
374 SAVE TO KEYSERVER
093d2e0761d4 docs: add directions on saving the key to the pgp.mit.edu keyserver
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
375 =================
093d2e0761d4 docs: add directions on saving the key to the pgp.mit.edu keyserver
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
376
093d2e0761d4 docs: add directions on saving the key to the pgp.mit.edu keyserver
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
377 $ gpg --keyserver pgp.mit.edu --send-keys \
093d2e0761d4 docs: add directions on saving the key to the pgp.mit.edu keyserver
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
378 411E354B5D1AF26125D621221F2DD0CB756A76D8
093d2e0761d4 docs: add directions on saving the key to the pgp.mit.edu keyserver
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
379
093d2e0761d4 docs: add directions on saving the key to the pgp.mit.edu keyserver
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
380 update it on the keysserver so users can download it.
Roundup Issue Tracker: http://roundup-tracker.org/