From e2f3c6582df183fa066bbebfe2088a515df9a790 Mon Sep 17 00:00:00 2001 From: swetha1654 Date: Thu, 21 Aug 2025 17:44:26 +0530 Subject: [PATCH 1/2] Add changelog --- .github/pull_request_template.yaml | 1 + CHANGELOG.md | 1 + docs/changelog.md | 11 +++++++++++ 3 files changed, 13 insertions(+) create mode 120000 CHANGELOG.md create mode 100644 docs/changelog.md diff --git a/.github/pull_request_template.yaml b/.github/pull_request_template.yaml index 5ce31d9..fa68511 100644 --- a/.github/pull_request_template.yaml +++ b/.github/pull_request_template.yaml @@ -28,5 +28,6 @@ Applicable spec: - [ ] The documentation is generated using `src-docs` - [ ] The documentation for charmhub is updated - [ ] The PR is tagged with appropriate label (`urgent`, `trivial`, `complex`) +- [ ] The [changelog](../docs/changelog.md) is updated with user-relevant changes in the format of [keep a changelog v1.1.0](https://keepachangelog.com/en/1.1.0/) diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 120000 index 0000000..1bed66b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1 @@ +docs/changelog.md \ No newline at end of file diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..2876d9c --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,11 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). + +Each revision is versioned by the date of the revision. + +## 2025-08-21 + +- Changelog added for tracking changes. From b2bc95cf0aaa0278f862e5d0bdc48cd7f3da7769 Mon Sep 17 00:00:00 2001 From: swetha1654 Date: Thu, 21 Aug 2025 17:45:33 +0530 Subject: [PATCH 2/2] remove src-docs --- .github/pull_request_template.yaml | 1 - generate-src-docs.sh | 6 ------ tox.ini | 12 ------------ 3 files changed, 19 deletions(-) delete mode 100644 generate-src-docs.sh diff --git a/.github/pull_request_template.yaml b/.github/pull_request_template.yaml index fa68511..ca22bdc 100644 --- a/.github/pull_request_template.yaml +++ b/.github/pull_request_template.yaml @@ -25,7 +25,6 @@ Applicable spec: - [ ] The [charm style guide](https://juju.is/docs/sdk/styleguide) was applied - [ ] The [contributing guide](https://github.com/canonical/is-charms-contributing-guide) was applied - [ ] The changes are compliant with [ISD054 - Managing Charm Complexity](https://discourse.charmhub.io/t/specification-isd014-managing-charm-complexity/11619) -- [ ] The documentation is generated using `src-docs` - [ ] The documentation for charmhub is updated - [ ] The PR is tagged with appropriate label (`urgent`, `trivial`, `complex`) - [ ] The [changelog](../docs/changelog.md) is updated with user-relevant changes in the format of [keep a changelog v1.1.0](https://keepachangelog.com/en/1.1.0/) diff --git a/generate-src-docs.sh b/generate-src-docs.sh deleted file mode 100644 index 4e96bc2..0000000 --- a/generate-src-docs.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/usr/bin/env bash - -# Copyright 2025 Canonical Ltd. -# See LICENSE file for licensing details. - -lazydocs --no-watermark --output-path src-docs src/* diff --git a/tox.ini b/tox.ini index 91a5078..48be86f 100644 --- a/tox.ini +++ b/tox.ini @@ -115,15 +115,3 @@ deps = -r{toxinidir}/requirements.txt commands = pytest -v --tb native --ignore={[vars]tst_path}unit --log-cli-level=INFO -s {posargs} - -[testenv:src-docs] -allowlist_externals=sh -setenv = - PYTHONPATH = {toxinidir}:{toxinidir}/lib:{[vars]src_path} -description = Generate documentation for src -deps = - lazydocs - -r{toxinidir}/requirements.txt -commands = - ; can't run lazydocs directly due to needing to run it on src/* which produces an invocation error in tox - sh generate-src-docs.sh