app/soc/release.py

   1 # Copyright 2008 the Melange authors.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 """Release tag string for display in templates (and possibly other uses).
  16
  17 Steps (currently done by hand, but too be scripted in the future) to make
  18 a release:
  19
  20 1) set RELEASE_TAG in this file to a "release candidate" release string that
  21    ends in "rc"
  22
  23 2) commit this file *by itself* in its own commit
  24
  25 3) use 'svn cp' to create a release branch in /branches/ with exactly the
  26    same name as the contents of the RELEASE_TAG string
  27
  28 4) set RELEASE_TAG back to None in /trunk/
  29
  30
  31 To finalize a release candidate in a release branch for a push to the live
  32 web site:
  33
  34 1) in the release branch, change RELEASE_TAG to remove the trailing "rc"
  35
  36 2) commit this file in the release branch *by itself* in its own commit
  37
  38 3) use 'svn cp' to create a tag in /tags/ with exactly the same name as the
  39    contents of the RELEASE_TAG string
  40
  41 4) put the release branch in a state where it is ready for additional patches
  42    after the tag by setting the end of the RELEASE_TAG string to "p0"
  43
  44
  45 To re-release a previously-tagged release branch after a patch for a push to
  46 the live web site:
  47
  48 1) increment the "patch suffix" of the RELEASE_TAG string to the next integer
  49    (for example, "p0" becomes "p1", so the first tagged patch release will
  50    always be "p1", not "p0", which is just a placeholder)
  51
  52 2) (same as #2 for a release candidate)
  53
  54 3) (same as #3 for a release candidate)
  55
  56 4) (there is no step 4)
  57 """
  58
  59 __authors__ = [
  60   '"Todd Larsen" <tlarsen@google.com>',
  61   ]
  62
  63
  64 RELEASE_TAG = None
  65