|
cannam@62
|
1 How to release
|
|
cannam@62
|
2 ==============
|
|
cannam@62
|
3
|
|
cannam@62
|
4 **Developing**
|
|
cannam@62
|
5
|
|
cannam@62
|
6 * First, develop some new features to release! As you do, make sure to keep the documentation
|
|
cannam@62
|
7 up-to-date.
|
|
cannam@62
|
8
|
|
cannam@62
|
9 **Testing**
|
|
cannam@62
|
10
|
|
cannam@62
|
11 * Run `super-test.sh` on as many platforms as you have available. Remember that you can easily run
|
|
cannam@62
|
12 on any machine available through ssh using `./super-test.sh remote [hostname]`. Also run in
|
|
cannam@62
|
13 Clang mode. (If you are Kenton and running from Kenton's home machine and network, use
|
|
cannam@62
|
14 `./mega-test.py mega-test.cfg` to run on all supported compilers and platforms.)
|
|
cannam@62
|
15
|
|
cannam@62
|
16 * Manually test Windows/MSVC -- unfortunately this can't be automated by super-test.sh.
|
|
cannam@62
|
17
|
|
cannam@62
|
18 * Manually run the pointer fuzz tests under Valgrind. This will take 40-80 minutes.
|
|
cannam@62
|
19
|
|
cannam@62
|
20 valgrind ./capnp-test -fcapnp/fuzz-test.c++
|
|
cannam@62
|
21
|
|
cannam@62
|
22 * Manually run the AFL fuzz tests by running `afl-fuzz.sh`. There are three test cases, and ideally each should run for 24 hours or more.
|
|
cannam@62
|
23
|
|
cannam@62
|
24 **Documenting**
|
|
cannam@62
|
25
|
|
cannam@62
|
26 * Write a blog post discussing what is new, placing it in doc/_posts.
|
|
cannam@62
|
27
|
|
cannam@62
|
28 * Run jekyll locally and review the blog post and docs.
|
|
cannam@62
|
29
|
|
cannam@62
|
30 **Releasing**
|
|
cannam@62
|
31
|
|
cannam@62
|
32 * Check out the master branch in a fresh directory. Do NOT use your regular repo, as the release
|
|
cannam@62
|
33 script commits changes and if anything goes wrong you'll probably want to trash the whole thing
|
|
cannam@62
|
34 without pushing. DO NOT git clone the repo from an existing local repo -- check it out directly
|
|
cannam@62
|
35 from github. Otherwise, when it pushes its changes back, they'll only be pushed back to your
|
|
cannam@62
|
36 local repo.
|
|
cannam@62
|
37
|
|
cannam@62
|
38 * Run `./release.sh candidate`. This creates a new release branch, updates the version number to
|
|
cannam@62
|
39 `-rc1`, builds release tarballs, copies them to the current directory, then switches back to the
|
|
cannam@62
|
40 master branch and bumps the version number there. After asking for final confirmation, it will
|
|
cannam@62
|
41 upload the tarball to S3 and push all changes back to github.
|
|
cannam@62
|
42
|
|
cannam@62
|
43 * Install your release candidates on your local machine, as if you were a user.
|
|
cannam@62
|
44
|
|
cannam@62
|
45 * Go to `c++/samples` in the git repo and run `./test.sh`. It will try to build against your
|
|
cannam@62
|
46 installed copy.
|
|
cannam@62
|
47
|
|
cannam@62
|
48 * Post the release candidates somewhere public and then send links to the mailing list for people
|
|
cannam@62
|
49 to test. Wait a bit for bug reports.
|
|
cannam@62
|
50
|
|
cannam@62
|
51 * If there are any problems, fix them in master and start a new release candidate by running
|
|
cannam@62
|
52 `./release.sh candidate <commit>...` from the release branch. This will cherry-pick the specified
|
|
cannam@62
|
53 commits into the release branch and create a new candidate. Repeat until all problems are fixed.
|
|
cannam@62
|
54 Be sure that any such fixes include tests or process changes so that they don't happen again.
|
|
cannam@62
|
55
|
|
cannam@62
|
56 * You should now be ready for an official release. Run `./release.sh final`. This will remove the
|
|
cannam@62
|
57 "-rcN" suffix from the version number, update the version number shown on the downloads page,
|
|
cannam@62
|
58 build the final release package, and -- after final confirmation -- upload the binary, push
|
|
cannam@62
|
59 changes to git, and publish the new documentation.
|
|
cannam@62
|
60
|
|
cannam@62
|
61 * Submit the newly-published blog post to news sites and social media as you see fit.
|
|
cannam@62
|
62
|
|
cannam@62
|
63 * If problems are discovered in the release, fix them in master and run
|
|
cannam@62
|
64 `./release.sh candidate <commit>...` in the release branch to start a new micro release. The
|
|
cannam@62
|
65 script automatically sees that the current branch's version no longer contains `-rc`, so it starts
|
|
cannam@62
|
66 a new branch. Repeat the rest of the process above. If you decide to write a blog post (not
|
|
cannam@62
|
67 always necessary), do it in the master branch and cherry-pick it.
|
