~ubuntu-archive/ubuntu-archive-tools/trunk

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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
#!/usr/bin/python3

from datetime import datetime, timedelta
from textwrap import dedent

import argparse
import sys

THURSDAY = 3
SHOW_EMPTY_WEEKS = True


class ReleaseSchedule:
    # week number: "Text",
    # week number: ["Text", "Text"...],
    # week number: {"Text": { 'link':  https://wiki.ubuntu.com/<link>,
    #                         'weekday: [0-6], # Week day defaults to Thu (3) }},

    DEFAULT_MILESTONES = {
        1: "Toolchain Uploaded",
        10: "Ubuntu Testing Week (optional)",
        -8: {
            "Feature Freeze": {"link": "FeatureFreeze"},
            "Debian Import Freeze": {},
        },
        -7: "Ubuntu Testing Week (optional)",
        -5: {"User Interface Freeze": {"link": "UserInterfaceFreeze"}},
        -4: {
            "Documentation String Freeze": {"link": "DocumentationStringFreeze"}
        },
        -3: {"Beta Freeze": {"weekday": 0}, "Beta (mandatory)": {}},
        -2: {
            "Kernel Freeze": {"link": "KernelFreeze"},
            "Non Language Pack Translation Deadline": {
                "link": "NonLanguagePackTranslationDeadline",
            },
        },
        -1: {
            "Final Freeze": {"link": "FinalFreeze"},
            "Release Candidate": {"link": "ReleaseCandidate"},
            "Language Pack Translation Deadline": {
                "link": "LanguagePackTranslationDeadline",
            },
        },
        0: {"Final Release": {"link": "FinalRelease"}},
    }

    def __init__(self, codename, start_date, release_date):
        self.codename = codename
        self.start_date = start_date
        self.release_date = release_date
        self.release = f"{self.release_date:%y.%m}"
        # TODO: allow overriding on commandline
        self.milestones = ReleaseSchedule.DEFAULT_MILESTONES
        assert self.release_date > self.start_date

    def schedule_header(self):
        header = dedent(
            f"""
        # Ubuntu {self.codename} Release Schedule

        Week | Date (Thursday) | {self.release} events
        --- | --- | ---"""
        )
        return header

    def footer(self):
        release_date_nice = f"{self.release_date:%B %d %Y}"
        footer = dedent(
            f"""
# Ubuntu {self.codename} Release Task Signup Sheet

This signup sheet is to be used for planning release milestone tasks.

The Alpha and Beta 1 milestones have been replaced with [Testing Weeks](https://lists.ubuntu.com/archives/ubuntu-release/2018-April/004434.html), which are organized ad hoc at this point.

| Milestone         |     Date        | Image (Nusakan) Engineering | Checklist Tracking | Announcement Email |
| ----------------- | --------------- | --------------------------- | ------------------ | ------------------ |
| Feature Freeze    |                 | n/a                         | n/a                |                    |
| UI Freeze         |                 | n/a                         | n/a                |                    |
| Doc String Freeze |                 | n/a                         | n/a                |                    |
| {self.release} Beta        |                 |                             |                    |                    |
| Final Freeze      |                 |                             |                    |                    |
| {self.release} Release     | {release_date_nice} |                             |                    |                    |

When the archive is frozen, all members of the release team are expected to participate in bug fix reviews.

After [Feature Freeze](https://wiki.ubuntu.com/FeatureFreeze), all members of the release team are expected to participate in Feature Freeze Exception reviews in their particular area of expertise.

After [Final Beta](https://wiki.ubuntu.com/FinalBetaRelease), all members of the release team are expected to participate in Bug fix reviews in their particular area of expertise."""
        )
        return footer

    def _rows(self, include_milestones=True):
        (_, start_week_number, _) = self.start_date.isocalendar()
        (_, release_week_number, _) = self.release_date.isocalendar()
        if release_week_number > start_week_number:
            # October release
            nweeks = release_week_number - start_week_number
        else:
            nweeks = (52 - start_week_number + 1) + release_week_number
        # Week 1's Thursday is the Thursday AFTER the previous release
        current_date = self.start_date + timedelta(weeks=1)
        last_month = None
        rows = []
        for week in range(1, nweeks + 1):
            milestones = {}
            if include_milestones:
                negative_week_events = {
                    k: v for k, v in self.milestones.items() if k <= 0
                }.get(-(nweeks - week), [])
                positive_week_events = self.milestones.get(week, [])
                week_events = {}
                for events in (negative_week_events, positive_week_events):
                    if isinstance(events, str):
                        events = [events]
                    if isinstance(events, list):
                        events = {e: {} for e in events}
                    week_events = {**events, **week_events}

                for (milestone, details) in week_events.items():
                    link = details.get("link", None)
                    weekday = details.get("weekday", THURSDAY)
                    if weekday not in milestones:
                        milestones[weekday] = []
                    if link:
                        milestones[weekday].append(
                            f"[{milestone}](https://wiki.ubuntu.com/{link})"
                        )
                    else:
                        milestones[weekday].append(f"{milestone}")

            if SHOW_EMPTY_WEEKS and not len(milestones):
                milestones = {THURSDAY: {}}

            week_events_added = 0
            for (weekday, m) in milestones.items():
                date = current_date + timedelta(days=weekday - THURSDAY)

                if date.month != last_month:
                    rows.append(f"**{date:%B %Y}** |")
                elif week_events_added:
                    week = "⠀"  # utf-8 empty char "\u2800"

                date_fmt = f"{date:%B %d}"
                if weekday != THURSDAY:
                    date_fmt += f" ({date:%A})"

                rows.append(f'{week} | {date_fmt} | {", ".join(m)}')
                last_month = date.month
                week_events_added += 1

            current_date = current_date + timedelta(weeks=1)
        return "\n".join(rows)

    def schedule_rows(self):
        return self._rows(include_milestones=True)

    def transition_header(self):
        header = dedent(
            f"""
        # Planned and potentially disruptive archive-wide activities

        If you're planning a change that might have a disruptive effect on the archive - e.g. transitions or switches of important defaults (such as compiler versions) - list it here.

        Week | Date (Thursday) | Planned activity
        --- | --- | ---"""
        )
        return header

    def transition_rows(self):
        return self._rows(include_milestones=False)

    def __repr__(self):
        schedule_header = self.schedule_header()
        schedule_rows = self.schedule_rows()
        transition_header = self.transition_header()
        transition_rows = self.transition_rows()
        footer = self.footer()
        return f"{schedule_header}\n{schedule_rows}\n\n{transition_header}\n{transition_rows}{footer}"


def raise_if_not_thursday(date):
    if date.weekday() != THURSDAY:
        raise ValueError(f"Date {date} must be a Thursday")


if __name__ == "__main__":
    parser = argparse.ArgumentParser(
        description="Make a release schedule in markdown format"
    )
    parser.add_argument("codename", metavar="CODENAME", type=str)
    parser.add_argument("start", metavar="START", type=datetime.fromisoformat)
    parser.add_argument(
        "release", metavar="RELEASEDAY", type=datetime.fromisoformat
    )
    try:
        args = parser.parse_args()

        raise_if_not_thursday(args.start)
        raise_if_not_thursday(args.release)

        sched = ReleaseSchedule(args.codename, args.start, args.release)
        print(sched)
    except ValueError as e:
        print(e, file=sys.stderr)
        sys.exit(1)