Mercurial > hg > sv-dependency-builds
comparison src/capnproto-git-20161025/RELEASE-PROCESS.md @ 48:9530b331f8c1
Add Cap'n Proto source
author | Chris Cannam <cannam@all-day-breakfast.com> |
---|---|
date | Tue, 25 Oct 2016 11:17:01 +0100 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
47:d93140aac40b | 48:9530b331f8c1 |
---|---|
1 How to release | |
2 ============== | |
3 | |
4 * First, develop some new features to release! As you do, make sure to keep the documentation | |
5 up-to-date. | |
6 | |
7 * Run `super-test.sh` on as many platforms as you have available. Remember that you can easily run | |
8 on any machine available through ssh using `./super-test.sh remote [hostname]`. Also run in | |
9 Clang mode. (If you are Kenton and running from Kenton's home machine and network, use | |
10 `./super-test.sh kenton` to run on all supported compilers and platforms.) | |
11 | |
12 * Write a blog post discussing what is new, placing it in doc/_posts. | |
13 | |
14 * Run jekyll locally and review the blog post and docs. | |
15 | |
16 * Check out the master branch in a fresh directory. Do NOT use your regular repo, as the release | |
17 script commits changes and if anything goes wrong you'll probably want to trash the whole thing | |
18 without pushing. DO NOT git clone the repo from an existing local repo -- check it out directly | |
19 from github. Otherwise, when it pushes its changes back, they'll only be pushed back to your | |
20 local repo. | |
21 | |
22 * Run `./release.sh candidate`. This creates a new release branch, updates the version number to | |
23 `-rc1`, builds release tarballs, copies them to the current directory, then switches back to the | |
24 master branch and bumps the version number there. After asking for final confirmation, it will | |
25 upload the tarball to S3 and push all changes back to github. | |
26 | |
27 * Install your release candidates on your local machine, as if you were a user. | |
28 | |
29 * Go to `c++/samples` in the git repo and run `./test.sh`. It will try to build against your | |
30 installed copy. | |
31 | |
32 * Post the release candidates somewhere public and then send links to the mailing list for people | |
33 to test. Wait a bit for bug reports. | |
34 | |
35 * If there are any problems, fix them in master and start a new release candidate by running | |
36 `./release.sh candidate <commit>...` from the release branch. This will cherry-pick the specified | |
37 commits into the release branch and create a new candidate. Repeat until all problems are fixed. | |
38 Be sure that any such fixes include tests or process changes so that they don't happen again. | |
39 | |
40 * You should now be ready for an official release. Run `./release.sh final`. This will remove the | |
41 "-rcN" suffix from the version number, update the version number shown on the downloads page, | |
42 build the final release package, and -- after final confirmation -- upload the binary, push | |
43 changes to git, and publish the new documentation. | |
44 | |
45 * Submit the newly-published blog post to news sites and social media as you see fit. | |
46 | |
47 * If problems are discovered in the release, fix them in master and run | |
48 `./release.sh candidate <commit>...` in the release branch to start a new micro release. The | |
49 script automatically sees that the current branch's version no longer contains `-rc`, so it starts | |
50 a new branch. Repeat the rest of the process above. If you decide to write a blog post (not | |
51 always necessary), do it in the master branch and cherry-pick it. |