From 46033f2fd4a572b2ec793be0efd5a1e34f3e0ed7 Mon Sep 17 00:00:00 2001 From: Phan Trung Thanh Date: Tue, 9 Jan 2024 00:52:57 +0700 Subject: [PATCH] Add docs to metadata for gatekeeper (#6) * Add docs to metadata for gatekeeper Gatekeeper is using the `main` branch to fetch the charmhub url to the charm's doc set. This cause CI in PRs to fail because no PR has been merged to update this field * update license header --- charmcraft.yaml | 2 +- config.yaml | 2 +- generate-src-docs.sh | 2 +- metadata.yaml | 4 ++-- src/charm.py | 2 +- tests/conftest.py | 2 +- tests/integration/__init__.py | 2 +- tests/integration/test_charm.py | 2 +- tests/unit/__init__.py | 2 +- tests/unit/test_base.py | 2 +- tox.ini | 2 +- 11 files changed, 12 insertions(+), 12 deletions(-) diff --git a/charmcraft.yaml b/charmcraft.yaml index 197c03d..df6fdcb 100644 --- a/charmcraft.yaml +++ b/charmcraft.yaml @@ -1,4 +1,4 @@ -# Copyright 2023 Canonical Ltd. +# Copyright 2024 Canonical Ltd. # See LICENSE file for licensing details. # This file configures Charmcraft. # See https://juju.is/docs/sdk/charmcraft-config for guidance. diff --git a/config.yaml b/config.yaml index 13aed01..dd4dcdd 100644 --- a/config.yaml +++ b/config.yaml @@ -1,4 +1,4 @@ -# Copyright 2023 Canonical Ltd. +# Copyright 2024 Canonical Ltd. # See LICENSE file for licensing details. # This file defines charm config options, and populates the Configure tab on Charmhub. # If your charm does not require configuration options, delete this file entirely. diff --git a/generate-src-docs.sh b/generate-src-docs.sh index 2e6195c..d13066a 100644 --- a/generate-src-docs.sh +++ b/generate-src-docs.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -# Copyright 2023 Canonical Ltd. +# Copyright 2024 Canonical Ltd. # See LICENSE file for licensing details. lazydocs --no-watermark --output-path src-docs src/* diff --git a/metadata.yaml b/metadata.yaml index ce5d58d..4f2b2c3 100644 --- a/metadata.yaml +++ b/metadata.yaml @@ -1,4 +1,4 @@ -# Copyright 2023 Canonical Ltd. +# Copyright 2024 Canonical Ltd. # See LICENSE file for licensing details. # This file populates the Overview on Charmhub. # See https://juju.is/docs/sdk/metadata-reference for a checklist and guidance. @@ -14,7 +14,7 @@ display-name: Charm Template # (Required) summary: A very short one-line summary of the charm. -docs: https://discourse.charmhub.io +docs: https://discourse.charmhub.io/t/jenkins-agent-documentation-overview/12694 issues: https://github.com/canonical/is-charms-template-repo/issues maintainers: - https://launchpad.net/~canonical-is-devops diff --git a/src/charm.py b/src/charm.py index 15bab53..46227b1 100755 --- a/src/charm.py +++ b/src/charm.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 -# Copyright 2023 Canonical Ltd. +# Copyright 2024 Canonical Ltd. # See LICENSE file for licensing details. # Learn more at: https://juju.is/docs/sdk diff --git a/tests/conftest.py b/tests/conftest.py index 96d572b..ad7716b 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,4 +1,4 @@ -# Copyright 2023 Canonical Ltd. +# Copyright 2024 Canonical Ltd. # See LICENSE file for licensing details. """Fixtures for charm tests.""" diff --git a/tests/integration/__init__.py b/tests/integration/__init__.py index db3bfe1..e3979c0 100644 --- a/tests/integration/__init__.py +++ b/tests/integration/__init__.py @@ -1,2 +1,2 @@ -# Copyright 2023 Canonical Ltd. +# Copyright 2024 Canonical Ltd. # See LICENSE file for licensing details. diff --git a/tests/integration/test_charm.py b/tests/integration/test_charm.py index 4a35820..f212ec1 100644 --- a/tests/integration/test_charm.py +++ b/tests/integration/test_charm.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 -# Copyright 2023 Canonical Ltd. +# Copyright 2024 Canonical Ltd. # See LICENSE file for licensing details. """Integration tests.""" diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py index db3bfe1..e3979c0 100644 --- a/tests/unit/__init__.py +++ b/tests/unit/__init__.py @@ -1,2 +1,2 @@ -# Copyright 2023 Canonical Ltd. +# Copyright 2024 Canonical Ltd. # See LICENSE file for licensing details. diff --git a/tests/unit/test_base.py b/tests/unit/test_base.py index 540e957..c1ce697 100644 --- a/tests/unit/test_base.py +++ b/tests/unit/test_base.py @@ -1,4 +1,4 @@ -# Copyright 2023 Canonical Ltd. +# Copyright 2024 Canonical Ltd. # See LICENSE file for licensing details. # Learn more about testing at: https://juju.is/docs/sdk/testing diff --git a/tox.ini b/tox.ini index 9b17bd9..202340f 100644 --- a/tox.ini +++ b/tox.ini @@ -1,4 +1,4 @@ -# Copyright 2023 Canonical Ltd. +# Copyright 2024 Canonical Ltd. # See LICENSE file for licensing details. [tox]