Skip to content

Commit

Permalink
docs: add changelog with notes for 1.6.0
Browse files Browse the repository at this point in the history
Fixes #724
  • Loading branch information
tigarmo committed Oct 15, 2024
1 parent 9261dc7 commit 5cc65ea
Show file tree
Hide file tree
Showing 4 changed files with 161 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/.wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ Podman
ppa
pre
pyfiglet
PPAs
PyPI
reStructuredText
rock's
Expand Down
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@
"https://github.com/canonical/pebble#layer-specification",
"https://juju.is/cloud-native-kubernetes-usage-report-2021#selection-criteria-for-container-images",
"https://matrix.to/#/#rocks:ubuntu.com",
# Ignore changelog links to Rockcraft releases, because the changelog entries
# are written before the actual release is tagged.
"https://github.com/canonical/rockcraft/releases/tag/.*",
]

rst_epilog = """
Expand Down
156 changes: 156 additions & 0 deletions docs/reference/changelog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
:tocdepth: 2

.. Check out the bottom of the page for the release template
Changelog
*********

1.6.0 (2024-Oct-17)
-------------------

Core
====

- **Note**: This release of Rockcraft updates Pydantic, the internal library
used to process ``rockcraft.yaml`` files, to a new major version. This change
should not have any user-visible consequences but please report any issues at
:literalref:`https://github.com/canonical/rockcraft/issues`.
- Managed (non-destructive) runs now correctly fail if the build plan is empty.
For example, trying to build a project with only ``amd64`` in its
``platforms`` will now properly fail when buildings on a non-``amd64``
machine.
- ``package-repositories`` entries now support ``series`` and ``pocket`` for
``apt`` repositories, and ``key-id`` for PPAs.

Bases
#####

``bare``
""""""""

- ``bare``-based rocks now have a default ``PATH`` value set on the image,
following the behaviour of ``Pebble`` services.

Plugins
#######

``poetry``
""""""""""

- Add a new plugin for Python projects that use the `Poetry`_ build system.

Extensions
##########

fastapi-framework
"""""""""""""""""

- Add a new ``fastapi-framework`` extension for `FastAPI`_-based projects.

flask-framework
"""""""""""""""

- On ``bare``-based rocks, the extension now uses Chisel slices for the Python
interpreter.
- Add support for ``[email protected]``.

django-framework
""""""""""""""""

- The ``django-framework`` extension is now stable and no longer requires the
``ROCKCRAFT_ENABLE_EXPERIMENTAL_EXTENSIONS`` environment variable.
- Add support for ``[email protected]``.

go-framework
""""""""""""

- Add a new ``go-framework`` extension for Go-based projects.

Command line
============

- Improve reporting of builds that fail because they match multiple platforms.
- Improve error messages for invalid ``rockcraft.yaml`` files.
- The ``pack`` command now supports ``--shell`` and ``--shell-after``, and
correctly handles cases where the packing itself fails and the ``--debug``
argument is passed.
- The ``clean`` command now supports the ``--platform`` argument to filter which
build environments to clean.
- Positional arguments are now correctly display on the ``help`` output of
commands.
- The terminal cursor is now hidden during execution.

Init
====

- Add new ``--profile`` argument options for ``go-framework`` and
``fastapi-framework``.

Documentation
=============

- Add reference documentation for the new ``poetry`` plugin and the new
``go-framework`` extension.
- Add a how-to guide on adding internal users to rocks.
- Improve the ``flask-framework`` tutorial page based on user feedback.
- Add tutorial pages for the existing ``django-framework`` and the new
``fastapi-framework`` extensions.

For a complete list of commits, check out the `1.6.0`_ release on GitHub.


.. _FastAPI: https://fastapi.tiangolo.com
.. _Poetry: https://python-poetry.org

.. _1.6.0: https://github.com/canonical/rockcraft/releases/tag/1.6.0

..
release template:
X.Y.Z (YYYY-MMM-DD)
-------------------

Core
====

# for everything related to the lifecycle of packing a rock

Bases
#####

<[email protected]>
""""""""""""""
(order from newest base to oldest base)

Plugins
#######

<plugin>
""""""""

Extensions
##########

<extension>
"""""""""""

Metadata
########

Sources
#######


Command line
============

# for command line and UX changes

Init
====


Documentation
=============

For a complete list of commits, check out the `X.Y.Z`_ release on GitHub.
1 change: 1 addition & 0 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ Rockcraft's components, commands and keywords.
Extensions <extensions/index>
plugins
parts_steps
changelog

0 comments on commit 5cc65ea

Please sign in to comment.