summaryrefslogtreecommitdiffstats
path: root/wiki/src/contribute/how/documentation/release_notes.mdwn
blob: 4e56366e52b541238a3bb00392804a7b9c2d2280 (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
[[!meta title="Checklist for release notes"]]

  - Create a branch based on the development branch for this release
    - `web/nnnnn-x.y-release-notes`
    - Copy template from `contribute/how/documentation/release_notes/template.mdwn` to `news/version_x.y.mdwn`
    - Replace placeholders in template
  - Gather information about changes
    - Tails changelog
      - <https://git-tails.immerda.ch/tails/tree/debian/changelog?h=stable>
      - <https://git-tails.immerda.ch/tails/tree/debian/changelog?h=testing>
    - If a release candidate was announced, read the call for testing
    - Analyze the changes already made on the website and link to them:
      - in testing for a major release: `git diff origin/master...origin/testing wiki/src/**/*.{mdwn,html}`
      - in stable for a minor release: `git diff origin/master...origin/stable wiki/src/**/*.{mdwn,html}`
    - Analyze the Redmine view for this release
    - Analyze the diff of packages
      - in testing for a major release: `wget http://nightly.tails.boum.org/build_Tails_ISO_testing/lastSuccessful/archive/latest.iso.packages`
      - in stable for a minor release: `wget http://nightly.tails.boum.org/build_Tails_ISO_stable/lastSuccessful/archive/latest.iso.packages`
      - `diff -u ~/Persistent/master/wiki/src/torrents/files/tails-i386-*.packages latest.iso.packages | wdiff --diff-input --terminal`
    - Read the Changelog of other updated software (Tor, I2P, etc.) to find relevant highlights
      - Tor: <https://blog.torproject.org/>
      - Tor: <https://gitweb.torproject.org/tor.git/tree/ChangeLog>
      - Tor Browser: <https://gitweb.torproject.org/builders/tor-browser-bundle.git/tree/Bundle-Data/Docs/ChangeLog.txt?h=maint-6.5>
      - I2P: <https://geti2p.net/en/>
      - I2P: <https://github.com/i2p/i2p.i2p/blob/master/debian/changelog>
      - Icedove: <https://www.mozilla.org/en-US/thunderbird/notes/>
      - Electrum: <https://github.com/spesmilo/electrum/blob/master/RELEASE-NOTES>
      - TorBirdy: <https://gitweb.torproject.org/torbirdy.git/tree/ChangeLog>
      - obfs4proxy: <https://anonscm.debian.org/cgit/pkg-privacy/packages/obfs4proxy.git/tree/ChangeLog>
    - Add screenshots of cool stuff
      - Resize them to 66% if needed
    - Document manual steps that persistence users may need to go
      through, taking into account that we support automatic updates
      from the two last releases (not mentioning manual updates).
      It may imply to refer to, or copy from, such instructions that
      were documented in the _previous_ release notes.
  - Write the draft
    - Use full sentences for major changes ("*We installed*", "*You can*")
    - Use present tense without subject for minor changes ("*Upgrade*", "*Fix*")
    - Mention updates as "Update *Xyz* to [1.2.4]."
      - Mention previous version if we skipped some "Update Xyz from 1.0.0 to [1.2.3]."
      - Link to release notes if any, or changelog
    - Order items to put the most visible, less technical, and most popular
      items first while not being afraid of putting more technical items as
      well down the list.
  - Format
    - Link to ticket for fixed problems and changes that are well justified in Redmine
    - Put the period before ticket number
      - "Bla bla. ([!tails_ticket 1234])"
  - Prepare a tweet with highlights:
    - Tails x.y is out: https://tails.boum.org/news/version_x.y, bla bla bla, and more.
    - Add it as a comment to the ticket for the release notes.