summaryrefslogtreecommitdiff
path: root/doc/release
blob: 82213cf10870b35c0c2d30ddcfb9571659e7640c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
1. Preparation

[ ] Test with the latest GCC snapshot.

    - Build latest snapshot (see etc1/gcc/from-source.txt) and install in
      /usr/local. See previous snapshot build for configure command line.

    - Configure ODB manually in /tmp/odb and smoke-test

      Will need from-source.txt and
      export LD_LIBRARY_PATH=/usr/local/lib64:$LD_LIBRARY_PATH

      Build one of the test directories with this ODB:

      make odb=/tmp/odb/odb/odb

      Then compare with the same directory built with the previous
      version of GCC to detect any changes in the generated code.
      To clear the directories, use:

      find . -name '*.o' -o -name '*.d' -o -name driver | xargs rm

    - Run (replace -5)

    ./dist.sh -j 22 -complete -test -db pgsql -mssql-test-options \
--with-mssql-server=tcp:windows2008r2,1435 \
-ccp gcc-5 -cxxp g++-5 -cxxpflags "-W -Wall -O3" \
-cc gcc-5 -cxx g++-5 -cxxflags "-W -Wall -Wno-unknown-pragmas" \
2>&1 | tee dist.log

    - Check dist.log for new warnings

    - Uninstall snapshot from /usr/local

[ ] Test with old/new versions of databases.

[ ] Grep through @@.

    cd ~/work/odb/odb
    grep -r '@@' odb | grep '@@' | grep -v forward | grep -v Wextra

    - Make sure new simple value pragmas are added to the map in pragma.cxx

    - Make sure newly added options support database prefix, if necessary.

[ ] Run srccheck.pl.

    In ODB compiler:

    ~/work/xsd/srccheck.pl

    In runtimes:

    ~/work/xsd/srccheck.pl --runtime

[ ] Make sure correct license headers are used in respective runtimes
    (search for GPL, NCUEL).

[ ] Update version information, dates in: version, version.hxx, man pages,
    manual. Grep the source code for the previous version.

[ ] Proofread NEWS file.

[ ] Update/add prerequisites in INSTALL files.

[ ] Check documentation: manual XHTML, manual PDF, man pages, usage.


2. Source, Binary Packages and Testing

[ ] Run tests and examples from the build tree:

    make clean
    make -j 22 test 2>&1 | tee build.log
    grep -i warning build.log

[ ] Run alternative configuration tests:

    * Other DB versions
    * Other compilers/versions

    C++11:

    make conf=c++11 clean
    make conf=c++11 -j 22 test 2>&1 | tee build.log
    grep -i warning build.log

    Qt5:

    make conf=qt5 clean
    make conf=qt5 -j 22 test 2>&1 | tee build.log
    grep -i warning build.log

    C++11 autotools (latest GCC):

    ./dist.sh -j 22 -complete -test -mssql-test-options \
--with-mssql-server=tcp:windows2008r2,1435 \
-ccp gcc-4.8 -cxxp g++-4.8 -cxxpflags "-W -Wall -O3" \
-cc gcc-4.8 -cxx g++-4.8 -cxxflags "-std=gnu++11 -W -Wall -O3 -Wno-unknown-pragmas" \
2>&1 | tee dist.log

    Qt5 autotools:

    @@ TODO

    Clang:

    ./dist.sh -j 22 -rebuild -test -mssql-test-options \
--with-mssql-server=tcp:windows2008r2,1435 -cc clang -cxx clang++ \
-cxxflags "-W -Wall -Wno-unknown-pragmas -O0" 2>&1 | tee dist.log

    Clang C++11:

    ./dist.sh -j 22 -rebuild -test -mssql-test-options \
--with-mssql-server=tcp:windows2008r2,1435 -cc clang -cxx clang++ \
-cxxflags "-std=c++11 -W -Wall -Wno-unknown-pragmas -O0" 2>&1 | tee dist.log

[ ] Run adhoc-test/multi-db

    On Linux:

    make type=static clean
    make type=static -j 16
    make type=static test

    make type=dynamic clean
    make type=dynamic -j 16
    make type=dynamic test

    make -f makefile.rdynamic clean
    make -f makefile.rdynamic -j 16
    make -f makefile.rdynamic test

    make -f makefile.dll clean
    make -f makefile.dll -j 16
    make -f makefile.dll test
    make -f makefile.dll clean

    On Windows (after building all the runtimes as part of VC10 test below):

    - Copy over the test including the generated code (makefile.dll)
    - Build the solution with VC10
    - On Linux: make -f makefile.dll test-prep
    - Open new Command Prompt, run setenv.sh, then cd to test-adhoc and
      run test.bat

[ ] Package and test distribution (result in /tmp/pack/):

    ./dist.sh -j 22 -complete -test -ccp gcc-4.5 -cxxp g++-4.5 \
    -mssql-test-options --with-mssql-server=tcp:windows2008r2,1435 \
    2>&1 | tee dist.log
    grep -i warning dist.log

[ ] Test UNIX install:

    * Watch out for disk space; build in $HOME to be able to uninstall *

    cd ~/odb/build/install
    ~/work/odb/etc/test/unix/build -rebuild -test -mssql-test-options \
--with-mssql-server=tcp:windows2008r2,1435 -j 22 2>&1 | tee build.log
    grep -i warning build.log

[ ] Test Embedded:

    Copy libodb, libodb-sqlite, and odb-examples .tar.gz packages
    from /tmp/pack to adhoc-tests/raspi.

    Update ODB versions in the versions file.

    In new terminal:

    cd ~/work/odb/adhoc-tests/raspi
    ./build-static

    On raspi:

    cd /mnt/tmp/raspi
    ./driver --database /tmp/static.db
    ls -l ./driver # check/update size growth; previous was 546416
                                                            540432 2.2.0
							    558632 2.3.0
							    566952 2.4.0
    On dev:

    ./build-shared

    On raspi:

    export LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH
    ./driver --database /tmp/shared.db
    ls -l * # check/update size growth; previous was 35348/38244/107532
                                                     35024/61356/115468  2.2.0
                                                     35504/87348/119792  2.3.0
						     35980/102896/123840 2.4.0
    On dev:

    ./clean

[ ] Build Windows binary (new terminal):

    cd ~/work/odb/build/mingw-w64
    ./build-dist -j 22 -rebuild -pack 2>&1 | tee build.log

[ ] Test on Windows with VC8:

    Connect drive T:

    In Cygwin terminal:
      cd ~/projects/odb
      ./unpack
      ./all 0 8 all all all 2>&1 | tee all.log
      grep -i warning all.log

[ ] Test on Windows with VC9:

    Connect drive T:

    In Cygwin terminal:
      cd ~/projects/odb
      ./unpack
      ./all 4 9 all all all 2>&1 | tee all.log
      grep -i warning all.log

[ ] Test on Windows with MinGW:

    @@ UNIX install test.
    @@ C++11 build (maybe).

    Connect drive T:

    In MSYS terminal (ODB distribution):

      cd /c/projects/odb/mingw
      ./unpack
      ./build -rebuild -test 2>&1 | tee build.log
      grep -i warning build.log

[ ] Test on Windows with VC10:

    Connect drive T:

    In Cygwin terminal:
      cd ~/projects/odb
      ./unpack

      ./all 5 10 all all Win32 2>&1 | tee all.log
      ./all 4 10 all all x64 2>&1 | tee all.log

      grep -i warning all.log

[ ] Run multi-db test on Windows (see above).

[ ] Test on Windows with VC11:

    Connect drive T:

    In Cygwin terminal:
      cd ~/projects/odb
      ./unpack
      ./all 4 11 all all all 2>&1 | tee all.log
      grep -i warning all.log

[ ] Test on Windows with VC12:

    Connect drive T:

    In Cygwin terminal:
      cd ~/projects/odb
      ./unpack
      ./all 5 12 all all all 2>&1 | tee all.log
      grep -i warning all.log

[ ] Build and Test Solaris x86 binary:

    cd ~/work/odb/build
    ./pack solaris
    cd /tmp
    scp -r pack-solaris-X.Y.Z sol86:

    ssh sol86
    cd pack-solaris-X.Y.Z
    ./build-dist -rebuild -arch i686-solaris2.10 2>&1 | tee build.log
    cd test

    ./build-test -rebuild -test -j 1 ./cc-i686-12u2 2>&1 | tee build.log
    grep -i warning build.log

    ./build-test -rebuild -test -j 1 ./cc-i686-12u2-stlport 2>&1 | tee build.log
    grep -i warning build.log

[ ] Build and Test Solaris SPARC binary:

    cd ~/work/odb/build
    ./pack solaris
    cd /tmp
    scp -r pack-solaris-X.Y.Z fire:

    ssh fire
    cd pack-solaris-X.Y.Z
    ./build-dist -rebuild -arch sparc-solaris2.10 2>&1 | tee build.log
    cd test
    ./build-test -rebuild -test -j 2 ./cc-sparc-12u2 2>&1 | tee build.log
    grep -i warning build.log


[ ] Build and Test MacOS X x86 binary:

    cd ~/work/odb/build
    ./pack darwin
    cd /tmp
    scp -r pack-darwin-X.Y.Z pbook:

    ssh mini
    cd pack-darwin-X.Y.Z
    ./build-dist -rebuild -arch i686-apple-darwin10 2>&1 | tee build.log

    ssh mini
    cd pack-darwin-X.Y.Z/test
    ./build-test -rebuild -test -j 1 ./gcc-qt 2>&1 | tee build.log
    grep -i warning build.log

    ssh rbook
    cd pack-darwin-X.Y.Z/test
    ./build-test -rebuild -test -j 2 ./clang-cxx11 2>&1 | tee build.log
    grep -i warning build.log

[ ] Build and Test GNU/Linux x86 binary:

    @@ Verify features.h is removed from include-fixed.

    cd ~/work/odb/build
    ./pack linux-gnu

    On sarge32:
      scp -r shuya:/tmp/pack-linux-gnu-X.Y.Z
      cd pack-linux-gnu-X.Y.Z

      # Watch out for -libexecdir if using history.
      #
      ./build-dist -rebuild -arch i686-linux-gnu 2>&1 | tee build.log
      scp test/odb-X.Y.Z-i686-linux-gnu.tar.bz2 shuya:/tmp/pack-linux-gnu-X.Y.Z/test/

    On shuya:
      cd /tmp/pack-linux-gnu-X.Y.Z/test
      ./build-test -rebuild -test -j 16 ./gcc 2>&1 | tee build.log
      grep -i warning build.log

[ ] Build and Test GNU/Linux x86-64 binary:

    @@ Verify features.h is removed from include-fixed.

    cd ~/work/odb/build
    ./pack linux-gnu

    On sarge64:
      scp -r shuya:/tmp/pack-linux-gnu-X.Y.Z
      cd pack-linux-gnu-X.Y.Z

      # Watch out for -libexecdir if using history.
      #
      ./build-dist -rebuild -arch x86_64-linux-gnu 2>&1 | tee build.log
      scp test/odb-X.Y.Z-x86_64-linux-gnu.tar.bz2 shuya:/tmp/pack-linux-gnu-X.Y.Z/test/

    On shuya:
      cd /tmp/pack-linux-gnu-X.Y.Z/test
      ./build-test -rebuild -test -j 16 ./gcc 2>&1 | tee build.log
      grep -i warning build.log

    On fedora17-64:
      @@ TODO test with mysql, pgsql, and sqlite, Use gcc-minimal or
      install Boost and Qt.

      In the meantime, at least test person.hxx/bad.hxx

[ ] Build .deb packages

    Copy standard linux packages to build/debian/, unpack them:

    tar xfj odb-*-i686-linux-gnu.tar.bz2
    tar xfj odb-*-x86_64-linux-gnu.tar.bz2

    Update etc/binary/debian/changelog with a new version. See if any new
    doc/ or etc/ file were added, update rules if so.

    Copy the etc/binary/debian directory to the binary directories.

    cd odb-X.Y.Z-x86_64-linux-gnu
    dpkg-buildpackage -us -uc -rfakeroot

    cd odb-X.Y.Z-i686-linux-gnu
    dpkg-buildpackage -us -uc -rfakeroot -ai386

    Test each package:

    alien -t -g odb_X.Y.Z-N.deb # make sure dir structure is ok

    On sarge:

    sudo dpkg -i odb_X.Y.Z-N.deb
    which odb
    odb --version
    odb -d mysql person.hxx
    odb -d mysql private.hxx
    man odb
    sudo dpkg -P odb

[ ] Build .rpm packages

    Save standard linux packages in /tmp/pack and rebuild them with
    the -libexec libexec option. Copy them to ~/rmp/SOURCES/

    Edit odb.spec, update version, changelog. See if any new doc/ or
    etc/ file were added. Make sure default.options Debian-specific
    part is still 6 lines long.

    cd etc/binary/redhat
    rpmbuild -ba --target x86_64-pc-linux-gnu odb.spec
    rpmbuild -ba --target i686-pc-linux-gnu odb.spec

    Result is in ~/rpm/RPMS/

    Test each package:

    alien -t -g odb-X.Y.Z-N.rpm # make sure dir structure is ok

    On CentOS (32) and Fedora (64):

    sudo rpm -i odb-X.Y.Z-N.rpm
    which odb
    odb --version
    odb -d mysql person.hxx
    odb -d mysql private.hxx
    man odb
    sudo rpm -e odb

[ ] Tag the new version:

    ./tag.sh X.Y.Z


3. Dependencies

[ ] Release all dependencies that have changes.


4. Publishing

[ ] Generate .sha1-sums, latest links for binaries and source distributions:

    cd ~/work/codesynthesis.com/public/download/odb/X.Y
    ../../../../procedures/odb-sha1.sh X.Y.Z

    Capture .sha1 sums for later announcements.
    cat `ls *.sha1 | sort`

    ../../../../procedures/odb-latest.sh X.Y.Z-N

[ ] Project page modifications:

    + overview (if major new features worth mentioning)
    + features
    + examples
    + license (if adding new database)
    + build instructions for UNIX/Windows
    + platforms and compilers

    Proofread changes.

[ ] Copy doc/ leaving only .css, .png, .xhtml, .ps, and .pdf files. Make
    the following modifications to the .xhtml files:

    1. Remove XML declaration (the first line).
    2. Add IE conditional CSS inclusion:

       <!--[if lt IE 7]><link rel="stylesheet" type="text/css" href="/default-ie.css"/><![endif]-->

[ ] Update download links in the download page. Add new packages if any.

[ ] Test sandbox.

[ ] Sync sandbox with production (do --dry-run first):

    cd ~/work/codesynthesis.com
    rsync -avz --copy-unsafe-links --dry-run public/ codesynthesis.com:/var/www/codesynthesis.com/public/

[ ] While uploading, prepare mailing list announcement.

[ ] Test production.

[ ] Announce on the odb-users, odb-announcement mailing list.

[ ] Write shorter version of the announcement and update the following pages
    and feeds:

    /products/odb/index.xhtml  (News box)
    /products/odb/news.rss
    /projects/index.xhtml      (News box)
    /index.xhtml
    /news.xhtml
    /news.rss

    Test sanbox, then sync with production.

5. Announcements

[ ] Update version/release date in Wikipedia: main page and ORM comparison.

[ ] Write a blog post.

[ ] Write and send external announcement. See seperate page for the list
    of places.

[ ] Update Wikipedia page with new major features, if any.