-
Notifications
You must be signed in to change notification settings - Fork 5
/
index.rst
277 lines (191 loc) · 10 KB
/
index.rst
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
.. _release-notes:
Release notes
=============
This page lists past release notes for Starcraft, summarising new features, bug
fixes and backwards-incompatible changes in each version. It also contains the
release and support policies for Starcraft.
Current releases
----------------
<latest release>
~~~~~~~~~~~~~~~~
- <link to latest release, update, such as 8.2.0>
- <link to latest release, update, such as 8.1.0>
- <link to latest release, initial, such as 8.0.0>
<parallel release>
~~~~~~~~~~~~~~~~~~
<If necessary, add guidance and caveats about these older releases, such as
"Snapcraft 7 is available for building core18 snaps. When building for a newer
base, use Snapcraft 8.">
- <link to parallel release, update, such as 7.2.0>
- <link to parallel release, update, such as 7.1.0>
- <link to parallel release, initial, such as 7.0.0>
Past releases
-------------
<past release>
~~~~~~~~~~~~~~
- <link to past release, update, such as 6.2.0>
- <link to past release, update, such as 6.1.0>
- <link to past release, initial, such as 6.0.0>
.. _release-versioning:
Release versioning
------------------
Starcraft version naming follows the Semantic Versioning 2.0.0 scheme with
numbers for major, minor, and patch versions.
.. list-table::
:header-rows: 1
* - Version
- Example
- Significance
* - Major
- **3**.1.2
- <Apps: "A change that drops support for an earlier software base.">
<Libraries: "A change that breaks compatibility with the previous
version.">
* - Minor
- 3.\ **1**\ .2
- A new feature within the major version.
* - Patch
- 3.1.\ **2**
- A bug fix within the major or minor version.
Long-term support
-----------------
Starcraft doesn't have long-term support (LTS) releases. However, we typically
deliver a compatibility release shortly after Ubuntu LTS releases to ensure
continuity.
<Apps: Starcraft software bases are derived from Ubuntu LTS releases, and their
development keeps pace with the OS's new releases and support lifecycle.>
.. toctree::
:maxdepth: 1
.. release note template:
Starcraft 2.0 release notes
===========================
15 October 2024
Learn about the new features, changes, and fixes introduced in Starcraft 2.0.
Requirements and compatibility
------------------------------
Starcraft 2.0 requires Python 3.11 or higher.
<If there are multiple requirements, remove "Python 3.11 or higher" in the
previous paragraph and add a separate list here, with the same format of
"<package> or higher".>
For development and testing, Starcraft requires a <architecture> system or VM
with a minimum of <number>GB RAM.
What's new
----------
Starcraft 2.0 brings the following features, integrations, and improvements.
<Important change>
~~~~~~~~~~~~~~~~~~
<Try and stay within these guidelines when writing headings for important
changes.>
+----------------------------------------+------------------------------+-----------------------------------------+
| Type of change | Heading format | Example |
+========================================+==============================+=========================================+
| New feature | <Name of feature> | Snap deltas |
+----------------------------------------+------------------------------+-----------------------------------------+
| Support for technology, or integration | Support for <technology> | Support for signed commits |
| | <Technology> integration | Gnome integration |
+----------------------------------------+------------------------------+-----------------------------------------+
| Improvement to existing feature | <Describe improvement> | Faster buildset queries |
| | Improved <aspect of feature> | Improved language of buildset queries |
+----------------------------------------+------------------------------+-----------------------------------------+
| Other important update | <Describe update> | Mitigation for Heartbleed vulnerability |
+----------------------------------------+------------------------------+-----------------------------------------+
<Paragraph 1, optional: Briefly cover the previous behaviour or the change in
circumstances. For example, "With Ubuntu 24.04 LTS, the Snap Store and App
Center now collect public reviews for snaps and assign an averaged score to
them to provide users and authors an avenue for discoverability and
feedback.">
<Paragraph 2: Present the new behaviour or feature. In words, *show* what the
feature is and make a case for how the reader could benefit from it. Centre
the user whenever possible ("you"), and speak on behalf of Canonical ("we").
Prefer general, simple usage over complex applications. Use past tense. For
example, "We understand that some authors may not want to have their snaps
publicly ranked. If you prefer to disable ranking for your snap, we added the
``feedback`` key in Snapcraft recipes, which contains child keys for
controlling many of the rating and feedback features in the store. You can
declare ``voting: false`` to disable voting".>
<Paragraph 3, optional: Provide a call to action. This could take several
forms, such as a call to immediately perform a relevant action in Starcraft,
solicititation of the reader's feedback on a form or forum, or a link to
documentation, demo, blog post, and so on. For example, "See ``:ref:`Manage
store profile``` to configure how the public can engage with your snap on the
store".>
Minor features
--------------
Starcraft 2.0 brings the following minor changes.
<Feature A>
~~~~~~~~~~~
<Add a short list of changes to the feature. Keep each item brief and for the
most part descriptive. There's little need to sell the change or give a
detailed reason. Use past tense. For example, "- Made the error message for
``method()`` more descriptive and recommend a likely remedy.">
Backwards-incompatible changes
------------------------------
The following changes are incompatible with previous versions of Starcraft.
<"Removed" or "Disabled"> <feature B>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
<Paragraph 1, optional: Briefly cover the sequence of events that led to this
feature's removal. Use past tense. For example, "SP ABC-123 by the NIST,
published in October 2024, showed that algorithm X is no longer considered
adequate for protecting data in transit".>
<Paragraph 2: State precisely what was removed or disabled. Advise on an
alternative solution, or state if no alternative exists. If necessary,
describe the consequences of the reader's inaction. Link to relevant
documentation, standards, or public discussion. For example, "In accordance
with the report, Starcraft 2.0 no longer supports encryption algorithm X. As
of this release, if you haven't already we highly recommend you immediately
switch to encryption algorithm Y to ensure your data stays protected. For
more details about this decision and our policy, see ```Security notice on
encryption X <>`_`` on the Ubuntu blog.">
Feature deprecations
--------------------
The following features are deprecated in Starcraft 2.0:
Deprecated <feature C>
~~~~~~~~~~~~~~~~~~~~~~
<Use the same format as backwards-incompatible changes, but use present tense
to describe what is deprecated in this release, and how. Advise on an
alternative replacement, if it exists. This item is a statement of fact, not
a promise. If the implementation or schedule for the deprecation changed from
what we originally planned, don't make a point of it -- simply describe what
*is*. End by linking to relevant documentation, standards, or public
discussion. For example, "In October 2024, the NIST published SP ABC-123,
urging software publishers to cease the use of encryption algorithm X. We are
deprecating its usage in this release, and advise you to adopt algorithm Z as
a replacement. For more details about this decision and our policy, see
`Security notice on encryption X <>`_ on the Ubuntu blog.">
Scheduled feature deprecations
------------------------------
<Iterate on the following paragraph+items if you're covering multiple
versions in this section.>
The following features will be deprecated in Starcraft <planned version>:
<Feature D>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
<Future deprecation: Use the same format as backwards-incompatible changes,
but use future tense to describe what we *intend* and *plan* to do in
subsequent releases. Think of this as a promise or commitment to the reader,
and be mindful of the trust we want them to place in us. Don't write
conjecture or make promises about details that haven't been decided. Include
only the decisions that we have set in stone and information we're allowed to
disclose at of the release day. Use phrases like "we plan to", "we are
working on", or "we have scheduled development of". End by linking to
relevant documentation, standards, or public discussion. For example, "In
October 2024, the NIST published SP ABC-123, urging software publishers to
cease the use of encryption algorithm X. We plan to deprecate it in Starcraft
1.2. For more details about this decision and our policy, see `Security
notice on encryption X <>`_ on the Ubuntu blog.">
Known issues
------------
The following issues were reported and are scheduled to be fixed in upcoming
patch releases.
See individual issue links for any mitigations.
- <Ticket ID> <Title>
- <Ticket ID> <Title>
Fixed bugs and issues
---------------------
The following issues have been resolved in Starcraft 2.0:
- <Ticket ID> <Title>
- <Ticket ID> <Title>
Contributors
------------
We would like to express a big thank you to all the people who contributed to
this release.
`@alex <>`_, `@blair <>`_, `@cam <>`_, `@devin <>`_