[fix] add missing references to release notes 🤦

.github/workflows/automatic_doc_checks.yaml

@@ -8,8 +8,7 @@ on:
       - '8.0/edge'
   pull_request:
     paths:
-      - 'kubernetes/docs/**'
-      - 'machines/docs/**'
+      - '/docs/**'
   workflow_dispatch:
 
 
@@ -19,12 +18,7 @@ concurrency:
 
 jobs:
   documentation-checks:
-    strategy:
-      matrix:
-        path:
-          - kubernetes
-          - machines
     uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
     with:
-      working-directory: ${{ matrix.path }}/docs
+      working-directory: "docs"
       fetch-depth: 0

.github/workflows/check_libs.yaml

@@ -11,15 +11,14 @@ on:
     paths-ignore:
       - 'kubernetes/.gitignore'
       - 'kubernetes/.jujuignore'
-      - 'kubernetes/docs/**'
       - 'machines/.gitignore'
       - 'machines/.jujuignore'
-      - 'machines/docs/**'
       - 'LICENSE'
       - '**.md'
       - '.github/renovate.json5'
       - '.github/workflows/*.yaml'
-
+      - 'docs/**'
+
 jobs:
   lib-check:
     name: Check libraries

.github/workflows/ci.yaml

@@ -9,8 +9,7 @@ concurrency:
 on:
   pull_request:
     paths-ignore:
-      - 'kubernetes/docs/**'
-      - 'machines/docs/**'
+      - 'docs/**'
       - '**.md'
       - '.github/renovate.json5'
 

.github/workflows/integration_test.yaml

@@ -28,7 +28,7 @@ jobs:
       - name: Set up environment
         run: |
           sudo snap install go --classic
-          go install github.com/snapcore/spread/cmd/spread@latest
+          go install github.com/canonical/spread/cmd/spread@latest
           pipx install tox
           pipx install poetry
       - name: Collect spread jobs
@@ -83,7 +83,7 @@ jobs:
         # Default test results in case the integration tests time out or runner set up fails
         # (So that Allure report will show "unknown"/"failed" test result, instead of omitting the test)
         if: ${{ github.event_name == 'schedule' && github.run_attempt == '1' }}
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: allure-default-results-integration-test-${{ inputs.path-to-charm-directory }}
           path: ${{ inputs.path-to-charm-directory }}/allure-default-results/
@@ -114,15 +114,19 @@ jobs:
       - name: Checkout
         timeout-minutes: 3
         uses: actions/checkout@v5
+      - name: Install Python for tests
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
       - name: Set up environment
         timeout-minutes: 5
         run: |
           sudo snap install charmcraft --classic
           sudo snap install go --classic
-          go install github.com/snapcore/spread/cmd/spread@latest
+          go install github.com/canonical/spread/cmd/spread@latest
       - name: Download packed charm(s)
         timeout-minutes: 5
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           pattern: ${{ inputs.artifact-prefix }}-*
           merge-multiple: true
@@ -145,7 +149,7 @@ jobs:
         # Allure can only process one result per pytest test ID. If parameterization is done via
         # spread instead of pytest, there will be overlapping pytest test IDs.
         if: ${{ (success() || (failure() && steps.spread.outcome == 'failure')) && startsWith(matrix.job.spread_job, 'github-ci:ubuntu-24.04:') && endsWith(matrix.job.spread_job, ':juju36') && github.event_name == 'schedule' && github.run_attempt == '1' }}
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: allure-results-integration-test-${{ inputs.path-to-charm-directory }}-${{ matrix.job.name_in_artifact }}
           path: ${{ inputs.path-to-charm-directory }}/artifacts/${{ matrix.job.spread_job }}/allure-results/
@@ -186,7 +190,7 @@ jobs:
       - name: Upload logs
         timeout-minutes: 5
         if: ${{ !contains(matrix.job.spread_job, 'juju29') && (success() || (failure() && steps.spread.outcome == 'failure')) }}
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: logs-integration-test-${{ inputs.path-to-charm-directory }}-${{ matrix.job.name_in_artifact }}
           path: ~/logs/

.github/workflows/release.yaml

@@ -7,8 +7,7 @@ on:
     branches:
       - '8.0/edge'
     paths-ignore:
-      - 'kubernetes/docs/**'
-      - 'machines/docs/**'
+      - 'docs/**'
       - '.github/renovate.json5'
       - '.github/workflows/*.yaml'
 
@@ -58,7 +57,7 @@ jobs:
     secrets: inherit
 
   release:
-    name: Release charm | ${{ matrix.charm.path }}
+    name: Release charm | ${{ matrix.path }}
     needs:
       - build
       - integration-test

.github/workflows/release_test.yaml

@@ -28,7 +28,7 @@ jobs:
       - name: Set up environment
         run: |
           sudo snap install go --classic
-          go install github.com/snapcore/spread/cmd/spread@latest
+          go install github.com/canonical/spread/cmd/spread@latest
           pipx install tox
           pipx install poetry
       - name: Collect spread jobs
@@ -83,7 +83,7 @@ jobs:
         # Default test results in case the integration tests time out or runner set up fails
         # (So that Allure report will show "unknown"/"failed" test result, instead of omitting the test)
         if: ${{ github.event_name == 'schedule' && github.run_attempt == '1' }}
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: allure-default-results-release-test-${{ inputs.path-to-charm-directory }}
           path: ${{ inputs.path-to-charm-directory }}/allure-default-results/
@@ -119,10 +119,10 @@ jobs:
         run: |
           sudo snap install charmcraft --classic
           sudo snap install go --classic
-          go install github.com/snapcore/spread/cmd/spread@latest
+          go install github.com/canonical/spread/cmd/spread@latest
       - name: Download packed charm(s)
         timeout-minutes: 5
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           pattern: ${{ inputs.artifact-prefix }}-*
           merge-multiple: true
@@ -145,7 +145,7 @@ jobs:
         # Allure can only process one result per pytest test ID. If parameterization is done via
         # spread instead of pytest, there will be overlapping pytest test IDs.
         if: ${{ (success() || (failure() && steps.spread.outcome == 'failure')) && startsWith(matrix.job.spread_job, 'github-ci:ubuntu-24.04:') && endsWith(matrix.job.spread_job, ':juju36') && github.event_name == 'schedule' && github.run_attempt == '1' }}
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: allure-results-release-test-${{ inputs.path-to-charm-directory }}-${{ matrix.job.name_in_artifact }}
           path: ${{ inputs.path-to-charm-directory }}/artifacts/${{ matrix.job.spread_job }}/allure-results/
@@ -186,7 +186,7 @@ jobs:
       - name: Upload logs
         timeout-minutes: 5
         if: ${{ !contains(matrix.job.spread_job, 'juju29') && (success() || (failure() && steps.spread.outcome == 'failure')) }}
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: logs-release-test-${{ inputs.path-to-charm-directory }}-${{ matrix.job.name_in_artifact }}
           path: ~/logs/

.github/workflows/schedule.yaml

@@ -92,12 +92,12 @@ jobs:
       - name: Download default test results
         # Default test results in case the integration tests time out or runner set up fails
         # (So that Allure report will show "unknown"/"failed" test result, instead of omitting the test)
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           path: allure-default-results/
           name: allure-default-results-integration-test
       - name: Download test results
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           path: allure-results/
           pattern: allure-results-integration-test-*

machines/.readthedocs.yaml → .readthedocs.yaml

@@ -18,15 +18,15 @@ build:
     # This is a special exit code on Read the Docs that will cancel the build immediately.
     # https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
     - |
-      if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/8.0/edge -- 'machines/docs/' 'machines/.readthedocs.yaml';
+      if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/8.0/edge -- 'docs/' '.readthedocs.yaml';
       then
         exit 183;
       fi
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   builder: dirhtml
-  configuration: machines/docs/conf.py
+  configuration: docs/conf.py
   fail_on_warning: true
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
@@ -36,4 +36,4 @@ formats:
 # Optionally declare the Python requirements required to build your docs
 python:
   install:
-  - requirements: machines/docs/requirements.txt
+  - requirements: docs/requirements.txt

CONTRIBUTING.md

@@ -16,12 +16,13 @@ this operator.
   - Test coverage
   - User experience for Juju administrators of this charm.
 - Please help us out in ensuring easy to review branches by rebasing your pull request branch onto
-  the `main` branch. This also avoids merge commits and creates a linear Git commit history.
+  the `8.0/edge` branch. This also avoids merge commits and creates a linear Git commit history.
 
 ## Develop
-Install `tox`, `poetry`, and `charmcraftcache`
+Install `yq`, `tox`, `poetry`, and `charmcraftcache`
 
 ```shell
+pipx install yq
 pipx install tox
 pipx install poetry
 pipx install charmcraftcache
@@ -63,9 +64,12 @@ Build the charm in this git repository using:
 juju add-model dev
 juju model-config logging-config="<root>=INFO;unit=DEBUG"
 
+# Extract the K8s image
+export MYSQL_IMAGE=$(yq -r '.["resources"]["mysql-image"]["upstream-source"]' kubernetes/metadata.yaml)
+
 # Deploy the K8s or VM charm
-(cd kubernetes && juju deploy ./mysql-k8s_ubuntu-22.04-amd64.charm --resource mysql-image=...)
-(cd machines && juju deploy ./mysql_ubuntu-22.04-amd64.charm)
+(cd kubernetes && juju deploy ./mysql-k8s_ubuntu@22.04-amd64.charm --resource mysql-image=${MYSQL_IMAGE})
+(cd machines && juju deploy ./mysql_ubuntu@22.04-amd64.charm)
 ```
 
 ## Canonical Contributor Agreement

README.md

@@ -1,6 +1,6 @@
 # MySQL operators
-[![Charmhub](https://charmhub.io/mysql/badge.svg)](https://charmhub.io/mysql)
-[![Charmhub](https://charmhub.io/mysql-k8s/badge.svg)](https://charmhub.io/mysql-k8s)
+[![Charmhub](https://charmhub.io/mysql/badge.svg?channel=8.0/edge)](https://charmhub.io/mysql)
+[![Charmhub](https://charmhub.io/mysql-k8s/badge.svg?channel=8.0/edge)](https://charmhub.io/mysql-k8s)
 [![Release](https://github.com/canonical/mysql-operators/actions/workflows/release.yaml/badge.svg?branch=8.0/edge)](https://github.com/canonical/mysql-operators/actions/workflows/release.yaml)
 [![Tests](https://github.com/canonical/mysql-operators/actions/workflows/ci.yaml/badge.svg?branch=8.0/edge)](https://github.com/canonical/mysql-operators/actions/workflows/ci.yaml)
 
@@ -35,8 +35,7 @@ juju destroy-model mysql --destroy-storage --yes
 
 ## Documentation
 
-Please follow the tutorial guide ([K8s](https://canonical-charmed-mysql-k8s.readthedocs-hosted.com/tutorial/) or [VM](https://canonical-charmed-mysql.readthedocs-hosted.com/tutorial/)) 
-with detailed explanation how to access DB, configure cluster, change credentials and/or enable TLS.
+See the [official documentation](https://canonical-charmed-mysql.readthedocs-hosted.com/8.0) for more operational guidance, such as deployment on specific clouds, TLS, monitoring, backups, and troubleshooting.
 
 ## Relations
 

kubernetes/docs/.custom_wordlist.txt → docs/.custom_wordlist.txt

@@ -1,16 +1,23 @@
 # Leave a blank line at the end of this file to support concatenation
 airgap
+airgapped
 Artifactory
 async
 backend
 backends
 backport
+binlog
 Charmcraft
 cjk
+cron
 cryptographically
+CSR
+CSRs
 databag
 dvipng
+failover
 fonts
+fqdn
 freefont
 Furo
 github
@@ -24,24 +31,30 @@ Intersphinx
 io
 ip
 Jira
+kubectl
 landscape
 lang
 lastmod
 LaTeX
 latexmk
+logrotate
 MinIO
 Multipass
 mydumper
 mysql
+mysqldump
 MyST
 nameserver
 nameservers
 Open Graph
 otf
+Paxos
 PDF
 Percona
 plantuml
 PNG
+PPA
+PPAs
 PR
 PVC
 PVCs
@@ -58,18 +71,27 @@ snap_daemon
 Sphinx
 Spread
 spread_test_example
+stdout
+storages
 subproject
 subprojects
 SVG
+Sysbench
 tex
 texlive
 TOC
 toctree
+tracebacks
 txt
+teardown
 uncommenting
+systemd
+systemctl
+uncordon
 URL
 utils
 VMs
+walkthrough
 WCAG
 whitespace
 whitespaces