From 5d20f7e10cda0ea33c1023325b4df60c6196ae0c Mon Sep 17 00:00:00 2001
From: Tiago Nobrega <tiago.nobrega@canonical.com>
Date: Tue, 17 Dec 2024 12:25:28 -0300
Subject: [PATCH 1/3] chore(docs): add release-notes template from starbase

---
 docs/index.rst               |   1 +
 docs/release-notes/index.rst | 293 +++++++++++++++++++++++++++++++++++
 2 files changed, 294 insertions(+)
 create mode 100644 docs/release-notes/index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 5785a032d..138c4bc7b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -26,6 +26,7 @@ allowing complex operations to be declared at build time.
    how-to/index
    reference/index
    explanation/index
+   release-notes/index
 
 
 .. grid:: 1 1 2 2
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
new file mode 100644
index 000000000..d720c9d9c
--- /dev/null
+++ b/docs/release-notes/index.rst
@@ -0,0 +1,293 @@
+.. _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_policy_and_schedule:
+
+Release policy and schedule
+---------------------------
+
+<Apps: Canonical is committed to releasing Starcraft on a regular monthly
+cadence. Our goal is to have new features and fixes available as soon as
+possible. On the first Monday of the month, we publish a major or minor
+version of Starcraft to the candidate channel, where it undergoes testing and
+feedback. If we determine the candidate is ready for mainstream use by the
+Monday of the week after, we release it as a stable version. During testing
+and feedback of a candidate, we prioritise fixes for critical issues.>
+
+<Libraries: Canonical is committed to supporting the <"latest major release" or
+"last two major releases"> of Starcraft. [Optional: We forward-port changes in
+older releases to the latest release, if they're compatible.] Starcraft is
+released when it achieves development milestones in its lifecycle. It doesn't
+follow a predefined release cadence.>
+
+Starcraft release 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.
+  For information about the Starcraft release cycle, see the
+  :ref:`release_policy_and_schedule`.
+
+
+  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 <>`_

From 012f410a5e3db5509ca37fa2c668a9bb3480cfe5 Mon Sep 17 00:00:00 2001
From: Tiago Nobrega <tiago.nobrega@canonical.com>
Date: Tue, 17 Dec 2024 13:07:01 -0300
Subject: [PATCH 2/3] docs: apply release-notes template to rockcraft

---
 docs/reference/changelog.rst |  2 ++
 docs/release-notes/index.rst | 62 ++++++++----------------------------
 2 files changed, 15 insertions(+), 49 deletions(-)

diff --git a/docs/reference/changelog.rst b/docs/reference/changelog.rst
index 48b1838cd..c50f3bfbb 100644
--- a/docs/reference/changelog.rst
+++ b/docs/reference/changelog.rst
@@ -5,6 +5,8 @@
 Changelog
 *********
 
+.. _release-1.6.0:
+
 1.6.0 (2024-Oct-17)
 -------------------
 
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
index d720c9d9c..9ccb6d01b 100644
--- a/docs/release-notes/index.rst
+++ b/docs/release-notes/index.rst
@@ -3,67 +3,34 @@
 Release notes
 =============
 
-This page lists past release notes for Starcraft, summarising new features, bug
+This page lists past release notes for Rockcraft, summarising new features, bug
 fixes and backwards-incompatible changes in each version. It also contains the
-release and support policies for Starcraft.
+release and support policies for Rockcraft.
 
 
 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>
+Rockcraft 1
+~~~~~~~~~~~
 
+- :ref:`release-1.6.0`.
 
 .. _release_policy_and_schedule:
 
 Release policy and schedule
 ---------------------------
 
-<Apps: Canonical is committed to releasing Starcraft on a regular monthly
+Canonical is committed to releasing Rockcraft on a regular monthly
 cadence. Our goal is to have new features and fixes available as soon as
 possible. On the first Monday of the month, we publish a major or minor
-version of Starcraft to the candidate channel, where it undergoes testing and
+version of Rockcraft to the candidate channel, where it undergoes testing and
 feedback. If we determine the candidate is ready for mainstream use by the
 Monday of the week after, we release it as a stable version. During testing
-and feedback of a candidate, we prioritise fixes for critical issues.>
-
-<Libraries: Canonical is committed to supporting the <"latest major release" or
-"last two major releases"> of Starcraft. [Optional: We forward-port changes in
-older releases to the latest release, if they're compatible.] Starcraft is
-released when it achieves development milestones in its lifecycle. It doesn't
-follow a predefined release cadence.>
+and feedback of a candidate, we prioritise fixes for critical issues.
 
-Starcraft release naming follows the Semantic Versioning 2.0.0 scheme with
+Rockcraft release naming follows the Semantic Versioning 2.0.0 scheme with
 numbers for major, minor, and patch versions.
 
 .. list-table::
@@ -74,10 +41,7 @@ numbers for major, minor, and patch versions.
       - 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.">
+      - A change that drops support for an earlier software base.
     * - Minor
       - 3.\ **1**\ .2
       - A new feature within the major version.
@@ -89,12 +53,12 @@ numbers for major, minor, and patch versions.
 Long-term support
 -----------------
 
-Starcraft doesn't have long-term support (LTS) releases. However, we typically
+Rockcraft 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.>
+Rockcraft 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

From f204b4902307c6e2845cfed87e33e76c91ded79c Mon Sep 17 00:00:00 2001
From: Tiago Nobrega <tiago.nobrega@canonical.com>
Date: Tue, 17 Dec 2024 16:59:44 -0300
Subject: [PATCH 3/3] review: drop "Rockcraft 1", don't link to changelog

---
 docs/release-notes/index.rst | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
index 9ccb6d01b..f03d8f1ee 100644
--- a/docs/release-notes/index.rst
+++ b/docs/release-notes/index.rst
@@ -12,10 +12,7 @@ Current releases
 ----------------
 
 
-Rockcraft 1
-~~~~~~~~~~~
-
-- :ref:`release-1.6.0`.
+- <upcoming>.
 
 .. _release_policy_and_schedule: