summaryrefslogtreecommitdiff
path: root/RELEASING
blob: bf7317b53186c9501a8a70c4c0cdaed0abc7045b (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
Here are the steps to follow to create a new cairo release:

1) Ensure that there are no local, uncommitted modifications.
   It's probably good enough if "git status" says so.

2) Verify that the code passes "make distcheck"

	Running "make distcheck" should result in no warnings or
	errors and end with a message of the form:

	==================================================
	cairo-X.Y.Z-head archives ready for distribution:
	cairo-X.Y.Z-head.tar.gz
	==================================================

	(But the tar file isn't actually ready yet, as we still have
	some more steps to follow).

3) Fill out an entry in the NEWS file

	Sift through the information in ChangeLog since the last
	release. Summarize major changes briefly in a style similar
	to other entries in NEWS. Take special care to note any
	additions in the API. These should be easy to find
	by looking for cairo*.h in the ChangeLog. Additionally, the
	output of the following command should be examined using the
	previous release tag:

		find src/ -name '*.h' -not -name '*-private.h' -not -name 'cairoint.h' | \
		xargs git diff X.Y.Z --
	
	Note that for older releases made under CVS, the tag name is
	RELEASE_X_Y_Z instead.

4) Increment cairo_version_{minor|micro} and LT_{CURRENT|VERSION|AGE}
   in configure.in:

	If there are backward-incompatible changes in the API, stop
	now and don't release. Go back and fix the API instead. Cairo
	is intended to remain backwards-compatible as far as API.

	So cairo_version_major will not be incremented unless we come
	up with a new versioning scheme to take advantage of it.

	If there are API additions, then increment
	cairo_version_minor and reset cairo_version_micro to 0.

	Otherwise, (ie. there are only bug fixes), increment
	cairo_version_micro to the next larger (even) number.

	Adjust LT_CURRENT, LT_VERSION, and LT_AGE as describe in the
	comments in configure.in.

5) Commit the changes to NEWS and configure.in

	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
   for you:

	* Check that the version number ends with an even micro component
	* Check that no release exists with the current version
	* Verify that make distcheck completes successfully
	* 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
	* 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
	* Provide some text for the release announcement (see below).

7) Increment cairo_version_micro to the next larger (odd) number in
   configure, and commit.

8) Send a message to cairo-announce@cairographics.org and CC
   gnome-announce-list@gnome.org to announce the
   new release using the text provided from "make release-publish".