Workflow for the Release Point announcements
This page describe the current workflow and best practices for the creation and publication of announcements of release points.
This task has to be run by Publicity delegates and/or webmasters because you need permissions to stop cron jobs, build the website, and push to mirrors.
1. The release team will probably have written a draft (or two if there is release point for stable and oldstable) in the publicity announcements git repository under en/$year/YYYYMMDD.wml and have sent a mail to email@example.com (adding in CC firstname.lastname@example.org and email@example.com) asking for reviews and translations, so check the folders of other languages (or commit log of the repository).
1.1. Commit the announcement files to the website repo:
1.1.1. You need to add it to the webwml git repository at webwml/english/News/$year with the namescheme YYYYMMDD.wml. Add and commit the English version first. Then, take note of the hash of the commit of the English file (you can do "git log english/News/$year/YYYYMMDD.wml" and copy the hash of the most recent commit).
1.1.2. Then copy the translations to their corresponding folders (adding Makefiles if needed), and then edit them to add the hash in the "translation-check" header.
For example, let's say that the French translation file has a first line like this:
#use wml::debian::translation-check translation=" " maintainer="Jean-Pierre Giraud"
Then you have to paste the hash so it looks like something like this:
#use wml::debian::translation-check translation="0788aa9ab387393e2e9236d36df0630ae1c038c6" maintainer="Jean-Pierre Giraud"
Save the files, and then add and commit the translations (and makefiles if any) You can add and commit all the files at the same time.
1.1.3. Edit the /english/homepagenews.data file to add the YYYYMMDD of the announcement on top, and remove an old news (usually the announcement of the former release point, so we don't have for example 10.9 and 10.8 on the homepage). Commit the changes.
1.2. Publish the announcement. Run a partial rebuild of the website. We'll do it in two steps:
Rebuild the News folder:
ssh -tt www-master.debian.org sudo -u debwww /srv/www.debian.org/update-part News
Now update the homepage (and RSS):
ssh -tt www-master.debian.org sudo -u debwww NOSUBDIRS=1 /srv/www.debian.org/update-part index
1.3. Now you're ready for creating the mail: the script to create it is the publicity dpn repo under scripts/DPNhtml2mail.pl Please note that the script is not perfect: a check and a couple of adjustments by hand are usually required (and a patch to improve it, as well!)
IMPORTANT: we detected bug #950972 in buster, but sometimes we cannot reproduce. Use a stretch box, or review the output to see if the bug appears or not.
./scripts/DPNhtml2mail.pl -t news -i $year/$date
1.4. Send the mail to firstname.lastname@example.org.
1.5. Follow the instructions in https://micronews.debian.org/pages/contribute.html to send a microblogging that will be published in micronews.debian.org and mirrored in the @debian profile in different social networks.
2. For stable/oldstable point releases, almost the whole website needs to be rebuilt but the push to mirrors cannot be made until the installation images are ready (keep an eye on #debian-cd and #debian-release). We will update the website manually, without pushing to mirrors.
2.1. To avoid presenting an updated info in some places while the CD images are not ready yet, or while other parts of the website still didn't get updated, we would need to stop the cron jobs that build the website automatically, and thus update and build ourselves, and push to mirrors, as it is needed.
Open an ssh session in www-master.debian.org
Stop the cron jobs that build the website:
sudo -u debwww crontab -e
- and mark as comment the lines related to the website builds the ones that launch /srv/www.debian.org/cron/often and /srv/www.debian.org/cron/lessoften
2.2. We need to stop any job of website build that is running to avoid automatic push to mirrors. You can see the processes by typing (in www-master):
sudo -u debwww pstree -p debwww
and stop it with
sudo -u debwww kill PID
2.3. The files english/releases/codename/errata.wml and english/template/debian/release_info.wml need to be updated with the version number of the point release. In some cases, we also need to update english/releases/codename/index.wml and english/releases/codename/release.data (see below for the details).
Add a line in english/releases/codename/errata.wml to point to the URL of the announcement for the point release.
In the release_info.wml files there are several tags to be updated: current_release_codename , current_release_date_codename , current_release_newsurl_codename and current-cd-release; you can commit and push the changes to the repo, but any push to mirrors of the built files should wait until the the CD images are ready (that's why we stopped the cron jobs and the running jobs in www-master).
In the case of stable releases or final point release for an oldstable release, english/releases/codename/index.wml needs to be updated too.
In the case of oldstable releases, or the first publication of a stable release (i.e., a release becoming oldstable), english/releases/codename_oldstable/release.data needs to be updated too, adding or updating these tags:
<define-tag jessie-images-url>https://cdimage.debian.org/cdimage/archive/8.11.0</define-tag> <define-tag jessie-cd-release-filename>8.11.0</define-tag>
- In the case of stable and oldstable point release, you have to update the tags and wml files corresponding to both releases.
Commit the changes (in your local copy, no in www-master.debian.org)
2.4. In www-master.debian.org, build the relevant parts of the website, using the script:
sudo -u debwww NOMIRROR=1 /srv/www.debian.org/update-part CD
(Repeat the command changing CD for each one of the folders that use the release_info tags. At least: CD, distrib, ports, releases). This step usually takes more than 10 minutes. Each folder takes some minutes to update.
2.5. Build the homepage and files in the main folder with:
sudo -u debwww NOSUBDIRS=1 NOMIRROR=1 /srv/www.debian.org/update-part index
This step should take some minutes, not much.
2.6. If the images are not ready yet, you can build the other folders of the website with the same command of step 3.3. Don't build the "security" folder because that one takes too long. "Bugs" and "events" are also folders that take a while to build).
2.7. You can review the output of all the website builds in /srv/www.debian.org/www (or via web in https://www-staging.debian.org ).
3. Once the installation images are ready, you can repeat step 1.2 (update-part News) so the last translations of the announcement get published, and the folders that we built in the step 3 are pushed to mirrors (and the website looks updated and with links to the updated images).
This step may take more than 30 minutes.
4. And finally, undo the changes in crontab so the next website build runs as usual:
sudo -u debwww crontab -e
(the next rebuild will automatically rebuild the /security and other folders, if needed)
5. You may want to follow again the instructions in https://micronews.debian.org/pages/contribute.html to send a microblogging about the installation images of the new point release(s) ready to download from the Debian website (not needed if not much time passed between the announcement itself and this moment).
6. Remove the announcement from the publicity announcements git repository once it has been published.
8. Finally, update the debian-timeline with this event.