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: prepare 3.3 changelog #2038

Merged
merged 2 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ docs/_build/
# Auto-generated command reference
/docs/reference/commands/
/docs/reference/_autosummary/
/docs/common/craft-parts

# PyBuilder
target/
Expand Down
6 changes: 3 additions & 3 deletions common.mk
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ lint-docs: ##- Lint the documentation
ifneq ($(CI),)
@echo ::group::$@
endif
uv run --extra docs sphinx-lint --max-line-length 88 --enable all $(DOCS)
uv run --extra docs sphinx-lint --max-line-length 88 --ignore docs/reference/commands --enable all $(DOCS)
ifneq ($(CI),)
@echo ::endgroup::
endif
Expand Down Expand Up @@ -190,11 +190,11 @@ test-coverage: ## Generate coverage report

.PHONY: docs
docs: ## Build documentation
uv run --extra docs sphinx-build -b html -W $(DOCS) $(DOCS)/_build
uv run --extra docs sphinx-build -b html $(DOCS) $(DOCS)/_build

.PHONY: docs-auto
docs-auto: ## Build and host docs with sphinx-autobuild
uv run --extra docs sphinx-autobuild -b html --open-browser --port=8080 --watch $(PROJECT) -W $(DOCS) $(DOCS)/_build
uv run --extra docs sphinx-autobuild -b html --open-browser --port=8080 --ignore *.kate-swp --ignore docs/reference/commands/** --watch $(PROJECT) $(DOCS) $(DOCS)/_build
medubelko marked this conversation as resolved.
Show resolved Hide resolved

.PHONY: pack-pip
pack-pip: ##- Build packages for pip (sdist, wheel)
Expand Down
46 changes: 42 additions & 4 deletions docs/reference/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,51 @@ Changelog

For a complete list of commits, see the `X.Y.Z`_ release on GitHub.

X.Y.Z (2024-MM-DD)
3.3.0 (2025-01-13)
------------------

Core
====

Plugins
#######

- New :ref:`craft_parts_poetry_plugin`
- New :ref:`craft_parts_python_plugin`
lengau marked this conversation as resolved.
Show resolved Hide resolved

Reactive
""""""""

Extensions
##########

- New `fastapi-framework extension
<https://juju.is/docs/sdk/charmcraft-extension-fastapi-framework>`_
- The Django extension is no longer considered experimental.

- The ``charm`` command is now run in verbose mode by default.

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

The pack command now updates charm the libs in the project directory if they don't meet
the requirements in the ``charm-libs`` key of ``charmcraft.yaml``.
- The ``pack`` command now updates charm the libs in the project directory if they
don't meet the requirements in the ``charm-libs`` key of ``charmcraft.yaml``.
lengau marked this conversation as resolved.
Show resolved Hide resolved
- New :ref:`ref_commands_create-track` command.

Linter
======

- New linter to check that the entrypoint contains a call to ``ops.main()``

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

How-to guides for migrating to the new plugins:

- :ref:`howto-migrate-to-poetry`
- :ref:`howto-migrate-to-python`

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

3.2.2 (2024-10-16)
------------------
Expand Down Expand Up @@ -223,7 +260,7 @@ New Features
Charmcraft 3.1. Please have a go with it. Documentation is fairly minimal
right now, as the implementation is still in flux.
* The :ref:`ref_commands_upload-resource` command now uses
`skopeo <https://github.com/containers/skopeo>`_ to upload images. Most notably,
`skopeo`_ to upload images. Most notably,
this means you can enter
`any skopeo-supported containers-transports URL
<https://manpages.ubuntu.com/manpages/noble/man5/containers-transports.5.html>`_
Expand Down Expand Up @@ -376,3 +413,4 @@ page.
.. _3.2.0: https://github.com/canonical/charmcraft/releases/tag/3.2.0
.. _3.2.1: https://github.com/canonical/charmcraft/releases/tag/3.2.1
.. _3.2.2: https://github.com/canonical/charmcraft/releases/tag/3.2.2
.. _3.3.0: https://github.com/canonical/charmcraft/releases/tag/3.3.0
4 changes: 1 addition & 3 deletions docs/reference/plugins/python_plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ During the build step, the plugin performs the following actions:
2. It uses :command:`pip` to install the required Python packages specified
by the ``python-requirements``, ``python-constraints`` and ``python-packages``
keys.
4. It copies any existing ``src`` and ``lib`` directories from your charm project into
3. It copies any existing ``src`` and ``lib`` directories from your charm project into
the final charm.

Example
Expand All @@ -57,5 +57,3 @@ to build a charm for Ubuntu 24.04:

.. literalinclude:: python-charmcraft.yaml
:language: yaml


Loading