summaryrefslogtreecommitdiff
path: root/Build/source/libs/cairo/cairo-src/RELEASING
diff options
context:
space:
mode:
Diffstat (limited to 'Build/source/libs/cairo/cairo-src/RELEASING')
-rw-r--r--Build/source/libs/cairo/cairo-src/RELEASING68
1 files changed, 46 insertions, 22 deletions
diff --git a/Build/source/libs/cairo/cairo-src/RELEASING b/Build/source/libs/cairo/cairo-src/RELEASING
index 424902e9b68..8ac926e9bdd 100644
--- a/Build/source/libs/cairo/cairo-src/RELEASING
+++ b/Build/source/libs/cairo/cairo-src/RELEASING
@@ -1,5 +1,18 @@
Here are the steps to follow to create a new cairo release:
+0) Decide type of release and checkout the appropriate branch.
+
+ The Cairo project makes three types of releases: Development
+ snapshot releases, stable minor releases, and stable micro (aka
+ "point") releases. 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.
+
+ For stable releases (both minor and micro), the work should be
+ done on the given release branch. E.g. for 1.14.12, check out
+ the 1.14 branch via "git checkout origin/1.14 -b 1.14".
+
1) Ensure that there are no local, uncommitted/unpushed mods.
You're probably in a good state if both "git diff
@@ -45,12 +58,6 @@ Here are the steps to follow to create a new cairo release:
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:
@@ -76,8 +83,6 @@ Here are the steps to follow to create a new cairo release:
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
@@ -99,7 +104,7 @@ Here are the steps to follow to create a new cairo 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}
+ https://cairographics.org/releases/ChangeLog.cairo-${THIS_RELEASE}
4) Increment cairo_version_{minor|micro} in cairo-version.h:
@@ -117,12 +122,21 @@ Here are the steps to follow to create a new cairo release:
Otherwise, (i.e. there are only bug fixes), increment
cairo_version_micro to the next larger (even) number.
-5) Commit the changes to NEWS and cairo-version.h
+5) For Minor releases, add an index entry to doc/public/cairo-docs.xml
+
+ Towards the end of the file, add a new section for the stable
+ release. It'll look something like:
+
+ <index id="index-X.Y" role="X.Y">
+ <title>Index of new symbols in X.Y</title>
+ </index>
+
+6) Commit the changes to NEWS and cairo-version.h
It's especially important to mention the new version number in your
commit log.
-6) Run "make release-publish" which will perform the following steps
+7) Run "make release-publish" which will perform the following steps
for you:
* Generate ChangeLog files out of git repository
@@ -133,10 +147,10 @@ Here are the steps to follow to create a new cairo release:
* Generate the final tar file
* Generate an sha1sum file
* Sign the sha1sum using your GPG setup (asks for your GPG password)
- * scp the three files to appear on http://cairographics.org/releases
+ * scp the three files to appear on https://cairographics.org/releases
* Generate a versioned manual and upload it to appear as both:
- http://cairographics.org/manual-${THIS_RELEASE}
- http://cairographics.org/manual
+ https://cairographics.org/manual-${THIS_RELEASE}
+ https://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 ${THIS_RELEASE} tag, and sign
@@ -159,26 +173,33 @@ Here are the steps to follow to create a new cairo release:
previous versions, remove manual-${THIS_RELEASE} and
release/cairo-${THIS_RELEASE}.
-7) Update trunk (or the stable branch) version number.
+8) Push the new tag out to the central tree with a command like:
+
+ git push origin master ${THIS_RELEASE}
+
+9) Update master (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 Micro releases (X.Y.Z+2), increment cairo_version_micro to
+ the next larger (odd) number in cairo-version.h, commit, and
+ push.
+
+ DEVEL_VERSION="X.Y.Z+1" # e.g. 1.15.10 -> 1.15.11
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:
+ DEVEL_VERSION="X.Y.Z+1" # e.g. 1.16.0 -> 1.17.1
- git push origin master ${THIS_RELEASE}
+ git commit cairo-version.h -m "Bump version for ${DEVEL_VERSION}"
-9) Edit the cairo bugzilla product and add the new version numbers.
+10) 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).
-10) Send out an announcement message.
+11) Send out an announcement message.
Send a message to cairo-announce@cairographics.org and CC
cairo@cairographics.org, gnome-announce-list@gnome.org and
@@ -189,5 +210,8 @@ Here are the steps to follow to create a new cairo release:
git shortlog ${LAST_RELEASE}...
-11) Add the announcement to the NEWS page and the front page.
+12) Add the announcement to the website as a new entry in the news/
+ dir. It will automatically get indexed onto the homepage when the
+ site refreshes.
+