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

Add release notes page and release notes for 3.4 specifically. #2115

Merged
merged 12 commits into from
Jan 27, 2025
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Charmcraft
tutorial/index
howto/index
reference/index
release-notes/index

Charmcraft is a tool designed to simplify the creation, building, and sharing of a `Juju
charm <https://juju.is/docs/juju/charmed-operator>`_.
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Changelog
*********

Newer releases have their own :doc:`/release-notes/index` pages. Please refer
to those.

..
release template:

Expand Down Expand Up @@ -283,6 +286,7 @@ Bug fixes

For a complete list of commits, see the `3.1.0`_ release on GitHub.

.. _release-3.0.0:

3.0.0 (2024-03-14)
------------------
Expand Down Expand Up @@ -311,6 +315,7 @@ For a complete list of commits, see the `3.0.0`_ release on GitHub.

For a complete list of commits, see the `2.7.1`_ release on GitHub.

.. _release-2.7.0:

2.7.0 (2024-06-18)
------------------
Expand Down
145 changes: 145 additions & 0 deletions docs/release-notes/charmcraft-3.4.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
Charmcraft 3.4 release notes
============================

3 February 2025

Learn about the new features, changes, and fixes introduced in Charmcraft 3.4.


Requirements and compatibility
------------------------------

It is recommended that you install Charmcraft from the
`Snap store <https://snapcraft.io/charmcraft>`_, which provides automatic updates
and is the primary environment where it is tested. Most dependencies are included
within the Charmcraft snap, making installation easier.

If installed as a snap, the only external dependency is either `LXD`_ or
`Multipass`_.

Manual installation has the following requirements:

- Python 3.10 or higher
- libgit2 1.7
- `skopeo`_
- `Spread`_
- Either `LXD`_ or `Multipass`_

For development and testing, Charmcraft requires a modern Linux system or VM
with `Snap`_ and a minimum of 4 GiB RAM.
medubelko marked this conversation as resolved.
Show resolved Hide resolved

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

Charmcraft 3.4 brings the following features, integrations, and improvements.


``charmcraft promote``
~~~~~~~~~~~~~~~~~~~~~~

Charmcraft 3.4 has a new :ref:`ref_commands_promote` command, which can promote
a charm on Charmhub from one channel to another. The promote command automates the
following steps:

1. Find all charm revisions currently published on a given channel.
2. Find the revisions of each resource attached to that charm revision on the channel.
3. Release each of those charm revisions, with their appropriate resources, to a new
channel.

This means that if your charm supports three bases on two architectures, each
with its own resource revision, all six revisions will be released to the new
channel with the same resources.

Feature deprecations
--------------------

The following features are deprecated in Charmcraft 3.4 and will be removed in
Charmcraft 4.0:

Windows support
~~~~~~~~~~~~~~~

Charmcraft 3 has deprecated support running on Windows, and the upcoming 4.0
release will not have any amount of support for it. Please use
`Ubuntu inside WSL <https://ubuntu.com/desktop/wsl>`_.

Related issue: `#1810 <https://github.com/canonical/charmcraft/issues/1810>`_
lengau marked this conversation as resolved.
Show resolved Hide resolved

CentOS 7 support
~~~~~~~~~~~~~~~~

CentOS 7 reached its `End of life
<https://www.redhat.com/en/topics/linux/centos-linux-eol>`_ on 30 June 2024.
Charmcraft 3 will continue its current support for CentOS 7, but Charmcraft 4
will not support CentOS 7.

Related issue: `#1826 <https://github.com/canonical/charmcraft/issues/1826>`_

Bundle registration
~~~~~~~~~~~~~~~~~~~

New bundle registration `ceased on 1 November 2024
<https://discourse.charmhub.io/t/15344>`_
and Charmcraft's ``register-bundle`` command currently returns an error.
It will be removed entirely in Charmcraft 4.0

Related issue: `#1858 <https://github.com/canonical/charmcraft/issues/1858>`_

Scheduled feature deprecations
------------------------------

The following features will be deprecated in Charmcraft 4.0:


Bundle management
~~~~~~~~~~~~~~~~~

In line with the phasing out of bundles, Charmcraft 4.0 will deprecate all
bundle management commands. The removal versions have not been set.

Related issue: `#2113 <https://github.com/canonical/charmcraft/issues/2113>`_

``bundle`` plugin
~~~~~~~~~~~~~~~~~

In line with the phasing out of bundles, Charmcraft 4.0 will deprecate the
bundle plugin. No schedule has been set for the removal of the bundle plugin.

Related issue: `#2114 <https://github.com/canonical/charmcraft/issues/2114>`_

Known issues
------------

The following issues were reported and are scheduled to be fixed in upcoming
patch releases.

See individual issue links for any mitigations.

- `#2078 <https://github.com/canonical/charmcraft/issues/2078>`_
``charmcraft clean`` does not clean all platforms for a charm.
- `#2012 <https://github.com/canonical/charmcraft/issues/2012>`_ Charmcraft uses
``/cache`` as the cache directory if snapd doesn't set ``SNAP_USER_COMMON``
- `#1990 <https://github.com/canonical/charmcraft/issues/1990>`_ Cannot stage
packages with Charmcraft


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

The following issues have been resolved in Charmcraft 3.4:

- `#2081 <https://github.com/canonical/charmcraft/issues/2081>`_
``charmcraft pack`` fails because ``libffi-dev`` is missing.
- `#2058 <https://github.com/canonical/charmcraft/issues/2058>`_ Multi-base charm
uses the same LXD container for different bases


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

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

:literalref:`@bepri <https://github.com/bepri>`,
lengau marked this conversation as resolved.
Show resolved Hide resolved
:literalref:`@dariuszd21 <https://github.com/dariuszd21>`,
:literalref:`@lengau <https://launchpad.net/lengau>`
Loading
Loading