doc/release.txt

   1 Release check list
   2 ==================
   3
   4 When releasing a new version
   5 ----------------------------
   6
   7 1. Tasks in the elinks module:
   8
   9  - Go over the changes since the last release. Use git-shortlog as a template.
  10    Write a small changelog highlighting the most important changes. Changes
  11    by new contributors are always important!
  12  - Update NEWS file and commit. Remember to add the new version number!
  13    Don't add the release date yet though; it will be added after the release,
  14    from the date in the mailing list archives.
  15  - Change VERSION in the top of configure.in to hold the new version number.
  16  - Commit only this change.
  17  - Create a signed tag having the version ("ELinks X.X.X") as the subject and
  18    using the changelog create above as the body. Use something like:
  19
  20         $ cg-tag -s -M changelog.file elinks-X.X.X
  21
  22  - Append ".GIT" to the VERSION variable in the top of configure.in.
  23  - Commit only this change.
  24  - Push these changes plus tag using:
  25
  26         $ cg-push -t elinks-X.X.X
  27
  28 2. Tasks on http://elinks.cz/ (part 1):
  29
  30  - Wait until the tag etc. has been synced or force a sync of the repository
  31    at http://elinks.cz/elinks.git/.
  32  - Run script to create new tarballs (both .gz and .bz2).
  33
  34         $ mkdist elinks-X.X.X X.X.X -r
  35
  36 3. Tasks on localhost:
  37
  38  - Download new tarballs and create ASCII armored signature files.
  39
  40         $ gpg -b --armor elinks-X.X.X.tar.bz2
  41         $ gpg -b --armor elinks-X.X.X.tar.gz
  42
  43  - Copy the elinks-X.X.X.tar.*.asc files to http://elinks.cz/download/.
  44  - Send announcement to elinks-users mailing list.
  45
  46 4. Tasks in the elinks-web module:
  47
  48  - Change the version and release data in the start of website.conf.
  49  - Wait for the announcement to hit the elinks-users mailing list archive.
  50  - Add paraphrased version of the first paragraph of the release announcement
  51    as a news entry in news/latest.txt. Make the entry link to both the
  52    archived announcement from linuxfromscratch.org and gmane.org using the
  53    "magic numbers" expanded by the macro. Possibly, move the cut-off markers
  54    that control which news entries to display on the front page.
  55  - Rebuild index.html, download.html, news.html, and news.rss.
  56  - Commit the updates HTML and asciidoc files.
  57  - Push the commits.
  58
  59 5. Tasks on http://elinks.cz/ (part 2):
  60
  61  - Wait until the elinks-web module has been synced or force a sync of the
  62    repository.
  63  - Checkout the new updated webpages.
  64
  65 6. Tasks on http://bugzilla.elinks.cz/:
  66
  67  - Add the new version.
  68  - Add a comment to each bug fixed in this version.  If some of them
  69    are already VERIFIED, change them to CLOSED, unless they are also
  70    waiting for a release in another branch.
  71
  72 7. Tasks external sites and resources:
  73
  74  - Add a new release to the freshmeat.net page.
  75  - Change topic of #elinks
  76  - (Request update of FSFs free software directory).
  77  - (Update current version on wikipedia).
  78
  79 When releasing a new stable branch
  80 ----------------------------------
  81
  82 (I only vaguely remember this process. --jonas)
  83
  84 1. Tasks on localhost:
  85
  86  - Locally clone the freezed repository to a new repository that will contain
  87    the new stable branch.
  88  - Unfreeze the repository that was cloned by changing the VERSION variable in
  89    configure.in to the version of the new unstable branch (remember the
  90    ending ".GIT"), commit, and push.
  91  - Add new remote branch that will track the new stable "trunk". It should
  92    basically be the push URL of the cloned repository with "#elinks-X.X"
  93    appended.
  94  - Push to this new remote branch to create it.
  95  - Perform the normal version release tasks described above in this new
  96    repository.
  97
  98 2. Tasks on http://elinks.cz/:
  99
 100  - Update http://elinks.cz/download/*-current-* tarball links to point to the
 101    correct versions.
 102
 103 3. Tasks external sites and resources:
 104
 105  - Add a new branch to the freshmeat.net page.