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