From 0c4da26bdc531dee4fb9895d2791e4c1194cbc68 Mon Sep 17 00:00:00 2001 From: Tiago Nobrega Date: Thu, 30 Jan 2025 12:18:37 -0300 Subject: [PATCH] docs: release notes for Rockcraft 1.8.0 --- docs/release-notes/index.rst | 4 +- docs/release-notes/rockcraft-1-8-0.rst | 112 +++++++++++++++++++++++++ 2 files changed, 114 insertions(+), 2 deletions(-) create mode 100644 docs/release-notes/rockcraft-1-8-0.rst diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst index bef0c77fe..d2b13c463 100644 --- a/docs/release-notes/index.rst +++ b/docs/release-notes/index.rst @@ -11,8 +11,7 @@ It also contains the release and support policies for Rockcraft. Current releases ---------------- - -- :ref:`Rockcraft 1.7.0 ` +- :ref:`Rockcraft 1.8.0 ` .. _release_policy_and_schedule: @@ -61,6 +60,7 @@ development keeps pace with the OS's new releases and support lifecycle. :maxdepth: 1 :hidden: + Rockcraft 1.8.0 Rockcraft 1.7.0 diff --git a/docs/release-notes/rockcraft-1-8-0.rst b/docs/release-notes/rockcraft-1-8-0.rst new file mode 100644 index 000000000..b8bfbfeec --- /dev/null +++ b/docs/release-notes/rockcraft-1-8-0.rst @@ -0,0 +1,112 @@ +.. _release-1.8.0: + +Rockcraft 1.8.0 release notes +============================= + +31 January 2025 + +Learn about the new features, changes, and fixes introduced in Rockcraft 1.8.0. +For information about the Rockcraft release cycle, see the +:ref:`release_policy_and_schedule`. + + +Requirements and compatibility +------------------------------ + +To run Rockcraft, a system requires the following minimum hardware and +installed software. These requirements apply to local hosts as well as VMs and +container hosts. + + +Minimum hardware requirements +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- AMD64, ARM64, ARMv7-M, RISC-V 64-bit, PowerPC 64-bit little-endian, or S390x + processor +- 2GB RAM +- 10GB available storage space +- Internet access for remote software sources and the Snap Store + + +Platform requirements +~~~~~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + :widths: 1 3 3 + + * - Platform + - Version + - Software requirements + * - GNU/Linux + - Popular distributions that ship with systemd and are `compatible with + snapd `_ + - systemd + + +What's new +---------- + +Rockcraft 1.8.0 brings the following features, integrations, and improvements. + +Improved error reporting +~~~~~~~~~~~~~~~~~~~~~~~~ + +We improved the reporting of build-time errors to emphasize the precise cause +of the error. For example, here's the output of ``rockcraft build`` when trying +to compile curl with incorrect build options: + + +.. code-block:: shell + + rockcraft build + Failed to run the build script for part 'curl'. + Detailed information: + :: + ./configure + :: configure: error: select TLS backend(s) or disable TLS with --without-ssl. + :: Select from these: + :: --with-amissl + :: --with-bearssl + :: --with-gnutls + :: --with-mbedtls + :: --with-openssl (also works for BoringSSL and LibreSSL) + :: --with-rustls + :: --with-schannel + :: --with-secure-transport + :: --with-wolfssl + (...) + +New uv plugin +~~~~~~~~~~~~~ + +We added a plugin to build Python projects that use `uv`_, a new package and +project manager. See the :ref:`craft_parts_uv_plugin` reference page +for details. + +New jlink plugin +~~~~~~~~~~~~~~~~ + +We added a plugin that uses the `jlink`_ tool to create smaller, optimized +Java runtimes specific for your rock's set of JARs. See the TODO + +.. :ref:`craft_parts_jlink_plugin` reference page for details. + +Bash completion +~~~~~~~~~~~~~~~ + +We added a completion file to the Rockcraft snap, which allows command-line +completion of commands and options in Bash-compatible shells. Try it out by +typing ``rockcraft`` and pressing :kbd:`Tab` on your terminal. + +Contributors +------------ + +We would like to express a big thank you to all the people who contributed to +this release. + +:literalref:`@benhoyt`, +:literalref:`@bepri`, +and :literalref:`@tigarmo`. + +.. _jlink: https://docs.oracle.com/en/java/javase/21/docs/specs/man/jlink.html +.. _uv: https://docs.astral.sh/uv/