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/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 new file mode 100644 index 000000000..f03d8f1ee --- /dev/null +++ b/docs/release-notes/index.rst @@ -0,0 +1,254 @@ +.. _release-notes: + +Release notes +============= + +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 Rockcraft. + + +Current releases +---------------- + + +- . + +.. _release_policy_and_schedule: + +Release policy and schedule +--------------------------- + +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 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. + +Rockcraft 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 + - A change that drops support for an earlier software base. + * - 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 +----------------- + +Rockcraft doesn't have long-term support (LTS) releases. However, we typically +deliver a compatibility release shortly after Ubuntu LTS releases to ensure +continuity. + +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 + + +.. 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. + + or higher".> + + For development and testing, Starcraft requires a system or VM + with a minimum of GB RAM. + + + What's new + ---------- + + Starcraft 2.0 brings the following features, integrations, and improvements. + + + + ~~~~~~~~~~~~~~~~~~ + + + + +----------------------------------------+------------------------------+-----------------------------------------+ + | Type of change | Heading format | Example | + +========================================+==============================+=========================================+ + | New feature | | Snap deltas | + +----------------------------------------+------------------------------+-----------------------------------------+ + | Support for technology, or integration | Support for | Support for signed commits | + | | integration | Gnome integration | + +----------------------------------------+------------------------------+-----------------------------------------+ + | Improvement to existing feature | | Faster buildset queries | + | | Improved | Improved language of buildset queries | + +----------------------------------------+------------------------------+-----------------------------------------+ + | Other important update | | Mitigation for Heartbleed vulnerability | + +----------------------------------------+------------------------------+-----------------------------------------+ + + + + + + + + + Minor features + -------------- + + Starcraft 2.0 brings the following minor changes. + + + + ~~~~~~~~~~~ + + + + + Backwards-incompatible changes + ------------------------------ + + The following changes are incompatible with previous versions of Starcraft. + + + <"Removed" or "Disabled"> + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + + + `_`` on the Ubuntu blog."> + + + Feature deprecations + -------------------- + + The following features are deprecated in Starcraft 2.0: + + Deprecated + ~~~~~~~~~~~~~~~~~~~~~~ + + `_ on the Ubuntu blog."> + + + Scheduled feature deprecations + ------------------------------ + + + + The following features will be deprecated in Starcraft : + + + + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + `_ 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> + + + 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 <>`_