diff options
Diffstat (limited to 'Build/source/libs/cairo/cairo-src/RELEASING')
-rw-r--r-- | Build/source/libs/cairo/cairo-src/RELEASING | 125 |
1 files changed, 90 insertions, 35 deletions
diff --git a/Build/source/libs/cairo/cairo-src/RELEASING b/Build/source/libs/cairo/cairo-src/RELEASING index 641ac1fc4a5..424902e9b68 100644 --- a/Build/source/libs/cairo/cairo-src/RELEASING +++ b/Build/source/libs/cairo/cairo-src/RELEASING @@ -1,10 +1,11 @@ Here are the steps to follow to create a new cairo release: -1) Ensure that there are no local, uncommitted/unpushed - modifications. You're probably in a good state if both "git diff - HEAD" and "git log master..origin/master" give no output. Also make - sure you have libglib2.0-doc installed (else you'll get excessive - gtk-doc cross reference warnings in the next step). +1) Ensure that there are no local, uncommitted/unpushed mods. + + You're probably in a good state if both "git diff + HEAD" and "git log master..origin/master" give no output. Also make + sure you have libglib2.0-doc installed (else you'll get + excessive gtk-doc cross reference warnings in the next step). 2) Verify that the code passes "make distcheck" @@ -37,19 +38,52 @@ Here are the steps to follow to create a new cairo release: suite passing, here's the magic env vars to set when doing 'make distcheck' and 'make release-publish' that will let you get away with it. At any cost, never ever release without - (implied) distchecking. Every time we got around it, it turned + (implied) distchecking. Every time we got around it, it turned out to be a disaster. Anyway, here's the pass code: DISPLAY= CAIRO_TEST_TARGET=" " -3) Fill out an entry in the NEWS file +3) Decide what the new version number for the release will be. + + There are three types of releases: Minor, Micro, and + Snapshot. Micro releases should be only bugfixes and no API + additions. If there are API additions consider making a Minor + release. Snapshot releases can be done of the current + development tree between Minor releases, as desired. + + Cairo uses even numbers for official releases, and odd numbers + for development snapshots. Thus, for a Minor release it would + be: + + LAST_RELEASE="X.Y.Z" # e.g. 1.12.0 + THIS_RELEASE="X.Y+2.0" # e.g. 1.14.0 + + While for a Micro release the version numbers should be: + + LAST_RELEASE="X.Y.Z" # e.g. 1.14.0 + THIS_RELEASE="X.Y.Z+2" # e.g. 1.14.2 + + Snapshots are similar but have odd minor versions. Also, the + first snapshot release in a new series will be .2 rather than + .0, e.g.: + + LAST_RELEASE="X.Y.Z" # e.g. 1.14.0 + THIS_RELEASE="X.Y+1.0" # e.g. 1.15.2 + + and subsequent snapshots in that series are just normal micro + releases: + + LAST_RELEASE="X.Y.Z" # e.g. 1.15.2 + THIS_RELEASE="X.Y.Z+2" # e.g. 1.15.4 + + + +4) Fill out an entry in the NEWS file Sift through the logs since the last release. This is most easily done with a command such as: - git log --stat X.Y.Z.. - - where X.Y.Z is the previous release version. + git log --stat ${LAST_RELEASE}.. Summarize major changes briefly in a style similar to other entries in NEWS. Take special care to note any additions in @@ -58,8 +92,14 @@ Here are the steps to follow to create a new cairo release: the following command will show each patch that has changed a public header file since the given version: - find src/ -name '*.h' ! -name '*-private.h' ! -name 'cairoint.h' ! -name 'cairo-*features*.h' | \ - xargs git diff X.Y.Z.. -- + find src/ -name '*.h' ! -name '*-private.h' \ + ! -name 'cairoint.h' ! -name 'cairo-*features*.h' | \ + xargs git diff ${LAST_RELEASE}.. -- + + Include a link to the incremental ChangeLog for this release, + which we'll be uploading in a later step: + + http://cairographics.org/releases/ChangeLog.cairo-${THIS_RELEASE} 4) Increment cairo_version_{minor|micro} in cairo-version.h: @@ -95,11 +135,11 @@ Here are the steps to follow to create a new cairo release: * Sign the sha1sum using your GPG setup (asks for your GPG password) * scp the three files to appear on http://cairographics.org/releases * Generate a versioned manual and upload it to appear as both: - http://cairographics.org/manual-X.Y.Z + http://cairographics.org/manual-${THIS_RELEASE} http://cairographics.org/manual * Place local copies of the three files in the releases directory * Create a LATEST-package-version file (after deleting any old one) - * Tag the entire source tree with a tag of the form X.Y.Z, and sign + * Tag the entire source tree with a ${THIS_RELEASE} tag, and sign the tag with your GPG key (asks for your GPG password, and you may need to set GIT_COMMITTER_NAME and GIT_COMMITTER_EMAIL to match your public-key's setting or this fails.) @@ -107,32 +147,47 @@ Here are the steps to follow to create a new cairo release: If for some reason you lost this message, "make release-publish-message" prints it for you. -7) Increment cairo_version_micro to the next larger (odd) number in - cairo-version.h, commit, and push. + Upload the incremental ChangeLog generated by the above: + + scp ChangeLog.cache-${LAST_RELEASE}.. \ + cairographics.org:/srv/cairo.freedesktop.org/www/releases/ChangeLog.cairo-${THIS_RELEASE} + + To undo a release-publish, before you've sent any emails or + pushed changes to master, delete the locally created tag (git + tag -d ${THIS_RELEASE}); then log into the webserver, repoint + the manual and LATEST-cairo-${THIS_RELEASE} symlinks to the + previous versions, remove manual-${THIS_RELEASE} and + release/cairo-${THIS_RELEASE}. + +7) Update trunk (or the stable branch) version number. + + For Micro releases (X.Y.Z), increment cairo_version_micro to the + next larger (odd) number in cairo-version.h, commit, and push. + + For Minor releases (X.Y.0), increment cairo_version_minor to the + next larger (odd) number, and set cairo_version_micro to 1. Then + commit and push. + +8) Push the new tag out to the central tree with a command like: -8) Push the newly created tag out to the central tree with a command - something like: + git push origin master ${THIS_RELEASE} - git push origin master X.Y.Z +9) Edit the cairo bugzilla product and add the new version numbers. -9) Edit the cairo bugzilla product and add the new version numbers. Note - that you need to add two versions. One for the release/snapshot (with - an even micro version), another with the post-release version (with an - odd micro version). + Note that you need to add two versions. One for the + release/snapshot (with an even micro version), another with the + post-release version (with an odd micro version). -10) Send a message to cairo-announce@cairographics.org and CC - cairo@cairographics.org, gnome-announce-list@gnome.org and - ftp-release@lists.freedesktop.org (pr@lwn.net as well for major - releases) to announce the new release using the text provided from - "make release-publish", adding the excerpt from NEWS, your - signature, followed by the standard "What is cairo" and "Where to - get more information about cairo" blurbs from README, and finally - the shortlog of all changes since last release, generated by: +10) Send out an announcement message. - git shortlog X.Y.Z... + Send a message to cairo-announce@cairographics.org and CC + cairo@cairographics.org, gnome-announce-list@gnome.org and + ftp-release@lists.freedesktop.org (pr@lwn.net as well for major + releases) to announce the new release using the text provided from + "make release-publish", adding the excerpt from NEWS and + the shortlog of all changes since last release, generated by: - where X.Y.Z is the last released version. + git shortlog ${LAST_RELEASE}... -11) Edit the cairo wiki to add the announcement to the NEWS page and - the front page. (just the parts before your signature). +11) Add the announcement to the NEWS page and the front page. |