Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: release notes for 1.7.0 #776

Merged
merged 12 commits into from
Dec 20, 2024
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ test-shellcheck:

.PHONY: test-sphinx-lint
test-sphinx-lint:
sphinx-lint --ignore docs/sphinx-starter-pack/ --ignore docs/_build --ignore docs/env --max-line-length 80 -e all docs/*
sphinx-lint --ignore docs/sphinx-starter-pack/ --ignore docs/_build --ignore docs/env --max-line-length 80 -e all -d missing-underscore-after-hyperlink,missing-space-in-hyperlink docs/*

.PHONY: test-units
test-units: ## Run unit tests.
Expand Down
1 change: 1 addition & 0 deletions docs/.wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ hardcoded
html
https
init
integrations
interoperable
io
js
Expand Down
5 changes: 4 additions & 1 deletion docs/release-notes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Current releases
----------------


- <upcoming>.
- :ref:`Rockcraft 1.7.0 <release-1.7.0>`

.. _release_policy_and_schedule:

Expand Down Expand Up @@ -59,6 +59,9 @@ development keeps pace with the OS's new releases and support lifecycle.

.. toctree::
:maxdepth: 1
:hidden:

Rockcraft 1.7.0 <rockcraft-1-7-0>


.. release note template:
Expand Down
147 changes: 147 additions & 0 deletions docs/release-notes/rockcraft-1-7-0.rst
tigarmo marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
.. _release-1.7.0:

Rockcraft 1.7.0 release notes
medubelko marked this conversation as resolved.
Show resolved Hide resolved
medubelko marked this conversation as resolved.
Show resolved Hide resolved
=============================

20 December 2024

Learn about the new features, changes, and fixes introduced in Rockcraft 1.7.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 <https://snapcraft.io/docs/installing-snapd>`_
- systemd


What's new
----------

Rockcraft 1.7.0 brings the following features, integrations, and improvements.


Support for remote builds
~~~~~~~~~~~~~~~~~~~~~~~~~

We added support for remote builds, which leverage off-site compute for
medubelko marked this conversation as resolved.
Show resolved Hide resolved
building rocks and can build for multiple architectures with a single command.
Remote builds are hosted on Launchpad.

This feature is experimental and subject to change, and more information is
available by running ``rockcraft remote-build --help``. Feel free to provide
tigarmo marked this conversation as resolved.
Show resolved Hide resolved
feedback on the `Ubuntu Discourse`_ forum.

Minor features
--------------

Rockcraft 1.7.0 brings the following minor changes.


``init`` command
~~~~~~~~~~~~~~~~

The default base of the project file generated by ``rockcraft init`` has been
updated from ``[email protected]`` to ``[email protected]``.


Rockcraft snap
~~~~~~~~~~~~~~

The base of the Rockcraft snap was updated from core22 to core24.


Go extension
~~~~~~~~~~~~

A new :ref:`tutorial <build-a-rock-for-a-go-application>` and :ref:`reference
<go-framework-reference>` are available for the go-framework extension.


OCI image configuration
~~~~~~~~~~~~~~~~~~~~~~~

When using ``run-user: _daemon_``, the value of the ``Config.User`` key in the
generated rock has been updated from the user name (``_daemon_``) to its
numeric ID.


12-factor extensions
medubelko marked this conversation as resolved.
Show resolved Hide resolved
~~~~~~~~~~~~~~~~~~~~

We added support for Gunicorn async workers on the Django and Flask 12-factor
medubelko marked this conversation as resolved.
Show resolved Hide resolved
extensions.


12-factor app documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~

The documentation for the various 12-factor framework extensions has been
updated for clarity and to better conform with documentation best practices.


Maven and Ant plugins
~~~~~~~~~~~~~~~~~~~~~

We changed the location of the Java runtime executable on rocks built using the
the Maven and Ant plugins from ``/bin/java`` to ``/usr/bin/java``, as the
former conflicts with the user-merged Ubuntu base.

Fixed bugs and issues
---------------------

The following issues have been resolved in Rockcraft 1.7.0:

- `#659`_ Kubernetes ``runAsNonRoot`` incompatibility with
``run-user: _daemon_``.
- `#749`_ Trying to build the output of "expand-extensions" fails because of the
pebble part.


Contributors
------------

We would like to express a big thank you to all the people who contributed to
this release.

:literalref:`@dariuszd21<https://github.com/dariuszd21>`,
:literalref:`@erinecon<https://github.com/erinecon>`,
:literalref:`@javierdelapuente<https://github.com/javierdelapuente>`,
:literalref:`@lengau<https://github.com/lengau>`,
:literalref:`@linostar<https://github.com/linostar>`,
:literalref:`@tigarmo<https://github.com/tigarmo>`
and :literalref:`@vpa1977<https://github.com/vpa1977>`.

.. _Ubuntu Discourse: https://discourse.ubuntu.com/c/rocks/rockcraft/118

.. _#659: https://github.com/canonical/rockcraft/issues/659
.. _#749: https://github.com/canonical/rockcraft/issues/659
1 change: 1 addition & 0 deletions docs/spellingcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ matrix:
- div.visually-hidden
- img
- a.p-navigation__link
- a.reference.external
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,5 @@ commands = sphinx-autobuild {posargs: -W -b html --open-browser --port 8080} --w
[testenv:lint-docs]
description = Lint the documentation with sphinx-lint
base = docs
commands = sphinx-lint --ignore docs/_build -e all {posargs} docs/
commands = sphinx-lint --ignore docs/_build -e all -d missing-underscore-after-hyperlink,missing-space-in-hyperlink {posargs} docs/
labels = lint
Loading