summaryrefslogtreecommitdiff
path: root/doc/release-checklist.txt
blob: d239278b81694909cc8328a00e33629fb89a56df (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
OpenSCAD Release Checklist
--------------------------

o Pre-release preparations
  - Merge MCAD
    o In MCAD clone:
      $ git fetch upstream
      $ git merge upstream/master
      $ git push
    o In OpenSCAD:
      $ cd libraries/MCAD
      $ git pull
      $ cd ../..
      $ git commit -m "Updated MCAD"
      $ git push

(See bottom of this file for how to build release binaries)

o Set VERSION and VERSIONDATE environment variable
  (VERSIONDATE is new and used to identify releases. VERSION is for humans.
   For development builds, set VERSION and VERSIONDATE to the same value)

  export VERSION=2013.01
  export VERSIONDATE=2013.01.17

  It will be used by the commands below, as well as these files: 

  scripts/release-common.sh
  scripts/publish-macosx.sh
  scripts/publish-mingw-x.sh

o Update RELEASE_NOTES
o Update copyright year in AboutDialog.html and mainwin.cc

o Tag release
  git tag "openscad-$VERSION"

o build source package
  scripts/git-archive-all.py --prefix=openscad-$VERSION/ openscad-$VERSION.src.tar.gz

o Sanity check; build a binary or two and manually run some tests

o git push --tags

o Upload Source package
  $ ./scripts/googlecode_upload.py -s 'Source Code' -p openscad -l Featured,Type-Source openscad-$VERSION.src.tar.gz
  $ scp openscad-$VERSION.src.tar.gz openscad@files.openscad.org:www

o Remove VERSION environment variable
  $ unset VERSION

o Write release email/blog entry
o Update web page
  - news.html
  - inc/src_release_links.js
o Update external resources:
  - http://en.wikipedia.org/wiki/OpenSCAD
o Write to mailing list
o Tweet
o Notify package managers
  - Ubuntu: https://launchpad.net/~chrysn
  - Fedora: Miro HronĨok <miro@hroncok.cz> or <mhroncok@redhat.com>
  - OpenSUSE: Pavol Rusnak <prusnak@opensuse.org>
  - MacPorts: Frank Schima <macports2000@gmail.com>

Build and Upload Release Binaries
---------------------------------

$ export VERSIONDATE=<date of release in YYYY.MM.DD format, e.g. 2013.01.17>
$ export VERSION=<openscad version, e.g. 2013.01> # If development snapshot, you don't need version is the same as VERSIONDATE
$ tar xzf openscad-$VERSION.src.tar.gz
$ cd openscad-$VERSION

Mac OS X:

    $ ./scripts/publish-macosx.sh -> OpenSCAD-$VERSION.dmg

Linux:
    32-bit: run on a 32-bit machine or VM
    64-bit: run on a 64-bit machine or VM

    $ ./scripts/release-common.sh -> openscad-$VERSION.x86-ARCH.tar.gz
    (where ARCH will be detected and set to 32 or 64)
    $ ./scripts/googlecode_upload.py -s 'Linux Binaries' -p openscad openscad-$VERSION.x86-ARCH.tar.gz -l Featured,OpSys-Linux,Type-Archive openscad-$VERSION.x86-ARCH.tar.gz
    o Update web page with download links

Windows mingw cross-build:

FIXME: Adapt scripts/builder.sh to build release binaries
contact: Jan Huwald // Impressum