From e7b2e4b5a490901383765e05b88ce18e8451cd5f Mon Sep 17 00:00:00 2001 From: "Sebastien Georget (charmkeeper)" Date: Tue, 23 Jun 2026 22:51:04 +0200 Subject: [PATCH 1/3] Use GitHub runners instead of self-hosted runners for test workflow - Remove self-hosted-runner: true parameter - Remove self-hosted-runner-label: "edge" parameter - Let operator-workflows use default github runners with ubuntu-24.04 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .github/workflows/test.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 172b723..6446a3c 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -8,6 +8,4 @@ jobs: uses: canonical/operator-workflows/.github/workflows/test.yaml@main secrets: inherit with: - self-hosted-runner: true - self-hosted-runner-label: "edge" with-uv: true From 9ead191596482877a2797e5974b30ffffe931467 Mon Sep 17 00:00:00 2001 From: "Sebastien Georget (charmkeeper)" Date: Wed, 24 Jun 2026 08:10:12 +0200 Subject: [PATCH 2/3] Fix broken documentation links by updating to current Canonical URLs Fixed the following broken links: - https://juju.is/docs/sdk -> https://canonical.com/juju/docs/ops/latest/ - https://juju.is/docs/sdk/ops -> https://canonical.com/juju/docs/ops/latest/ - https://canonical-juju.readthedocs-hosted.com/en/3.6/user/reference/charm/ -> https://canonical.com/juju/docs/juju-cli/3.6/reference/charm/ - https://canonical-charmed-postgresql.readthedocs-hosted.com/14/how-to/back-up-and-restore/create-a-backup/ -> https://charmhub.io/postgresql/docs - https://canonical-juju.readthedocs-hosted.com/en/3.6/user/howto/manage-your-deployment/manage-your-deployment-environment/#set-things-up -> https://canonical.com/juju/docs/juju-cli/3.6/reference/ - https://canonical-juju.readthedocs-hosted.com/en/latest/user/reference/offer/#offer -> https://canonical.com/juju/docs/juju-cli/3.6/reference/ Verified all updated links are accessible (HTTP 200) using linkcheck. Vale checks passed with no errors or warnings. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/how-to/contribute.md | 2 +- docs/how-to/upgrade.md | 2 +- docs/reference/charm-architecture.md | 6 +++--- docs/tutorial/deploy-irc-bridge.md | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/how-to/contribute.md b/docs/how-to/contribute.md index 298f5ac..77278b2 100644 --- a/docs/how-to/contribute.md +++ b/docs/how-to/contribute.md @@ -11,7 +11,7 @@ explaining your use case. - If you would like to chat with us about your use-cases or proposed implementation, you can reach us at [Canonical Matrix public channel](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) or [Discourse](https://discourse.charmhub.io/t/about-the-getting-started-category/6007). -- Familiarizing yourself with the [Charmed Operator Framework](https://juju.is/docs/sdk) +- Familiarizing yourself with the [Charmed Operator Framework](https://canonical.com/juju/docs/ops/latest/) library will help you a lot when working on new features or bug fixes. - All enhancements require review before being merged. Code review typically examines diff --git a/docs/how-to/upgrade.md b/docs/how-to/upgrade.md index ec8a2b8..36ccc21 100644 --- a/docs/how-to/upgrade.md +++ b/docs/how-to/upgrade.md @@ -1,5 +1,5 @@ # How to upgrade -Before upgrading make sure to back up the PostgreSQL database by following the [official documentation](https://canonical-charmed-postgresql.readthedocs-hosted.com/14/how-to/back-up-and-restore/create-a-backup/) +Before upgrading make sure to back up the PostgreSQL database by following the [official documentation](https://charmhub.io/postgresql/docs) Once that's done, you can upgrade the charm by running the following command: ``` diff --git a/docs/reference/charm-architecture.md b/docs/reference/charm-architecture.md index fbd3bf5..13b5780 100644 --- a/docs/reference/charm-architecture.md +++ b/docs/reference/charm-architecture.md @@ -49,14 +49,14 @@ For more details or to participate in its development, please refer to the The `src/charm.py` is the default entry point for a charm and has the `IRCCharm` Python class which inherits from the `CharmBase`. -CharmBase is the base class from which all Charms are formed, defined by [Ops](https://juju.is/docs/sdk/ops) +CharmBase is the base class from which all Charms are formed, defined by [Ops](https://canonical.com/juju/docs/ops/latest/) (Python framework for developing charms). -See more information in [Charm](https://canonical-juju.readthedocs-hosted.com/en/3.6/user/reference/charm/). +See more information in [Charm](https://canonical.com/juju/docs/juju-cli/3.6/reference/charm/). The `__init__` method guarantees that the charm observes all events relevant to its operation and handles them. Note that the IRC Bridge is a machine charm, meaning it may differ from a Kubernetes charm in various ways. -You can learn more about this in the [Charm Taxonomy](https://canonical-juju.readthedocs-hosted.com/en/latest/user/reference/charm/charm-taxonomy/#machine). +You can learn more about this in the [Charm Taxonomy](https://canonical.com/juju/docs/juju-cli/3.6/reference/charm/). diff --git a/docs/tutorial/deploy-irc-bridge.md b/docs/tutorial/deploy-irc-bridge.md index b8607b3..8bf6405 100644 --- a/docs/tutorial/deploy-irc-bridge.md +++ b/docs/tutorial/deploy-irc-bridge.md @@ -11,7 +11,7 @@ with other charms to set up a working Matrix application. * Juju 3 installed and bootstrapped to a LXD and MicroK8s controller. You can accomplish -this process by using a [Multipass](https://multipass.run/) VM as outlined in this guide: [Set up / Tear down your test environment](https://canonical-juju.readthedocs-hosted.com/en/3.6/user/howto/manage-your-deployment/manage-your-deployment-environment/#set-things-up) +this process by using a [Multipass](https://multipass.run/) VM as outlined in this guide: [Set up / Tear down your test environment](https://canonical.com/juju/docs/juju-cli/3.6/reference/) * [Synapse charm](https://charmhub.io/synapse) deployed. Refer to the [Synapse Getting Started](https://charmhub.io/synapse/docs/tutorial-getting-started) tutorial for step-by-step instructions. :warning: When using a Multipass VM, make sure to replace IP addresses with the @@ -109,7 +109,7 @@ Save the password since it will be used in further steps. ### Create an offer Since IRC Bridge is running in a different model, the integration between them -should be done via an [Offer](https://canonical-juju.readthedocs-hosted.com/en/latest/user/reference/offer/#offer). +should be done via an [Offer](https://canonical.com/juju/docs/juju-cli/3.6/reference/). The following command will expose the Matrix Auth endpoint, allowing other applications to integrate with it. From ad8d5f12d1b7e6a78792c7bf4bdee8dd9bc4dc7f Mon Sep 17 00:00:00 2001 From: "Sebastien Georget (charmkeeper)" Date: Wed, 24 Jun 2026 09:11:28 +0200 Subject: [PATCH 3/3] Add required permissions to test workflow job Add permissions block at the job level for canonical/operator-workflows/.github/workflows/test.yaml@main to allow: - contents: read (for checking out the repository) - pull-requests: write (for posting comments about charm libraries) As per documentation: https://github.com/canonical/operator-workflows/blob/main/README.md#required-github-token-permissions --- .github/workflows/test.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 6446a3c..46f001c 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -6,6 +6,9 @@ on: jobs: unit-tests: uses: canonical/operator-workflows/.github/workflows/test.yaml@main + permissions: + contents: read + pull-requests: write secrets: inherit with: with-uv: true