Skip to content

fix: use upstream docs workflow#919

Merged
Thanhphan1147 merged 5 commits intocanonical:mainfrom
jahn-junior:work/docs-workflows
Feb 5, 2026
Merged

fix: use upstream docs workflow#919
Thanhphan1147 merged 5 commits intocanonical:mainfrom
jahn-junior:work/docs-workflows

Conversation

@jahn-junior
Copy link
Contributor

@jahn-junior jahn-junior commented Jan 28, 2026 •
edited
Loading

Overview

This repository is currently consuming the documentation checks in a non-standard way. The reusable workflow for documentation checks is documentation-workflows/.github/workflows/documentation-checks.yaml.

This PR updates docs_rtd.yaml to use the upstream workflow from canonical/documentation-workflows.

Rationale

The current workflow introduces an unnecessary layer between the workflow and its source. This workflow will soon be made unusable, as we want to ensure users are consuming it in the expected manner.

Workflow Changes

Update docs_rtd workflow to use canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main.

Checklist

@jahn-junior jahn-junior requested a review from a team as a code owner January 28, 2026 23:35
@jahn-junior jahn-junior requested review from DeeKay3 and yhaliaw and removed request for a team January 28, 2026 23:35
jahn-junior
jahn-junior commented Jan 28, 2026
View reviewed changes
erinecon
erinecon approved these changes Jan 29, 2026
View reviewed changes
Copy link
Contributor

@erinecon erinecon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks JJ! The changes LGTM

PS we won't be able to merge your PR because your commits aren't signed/verified, so you might need to reopen the PR :)

@jahn-junior
Copy link
Contributor Author

jahn-junior commented Jan 30, 2026

Amended signatures to my commits. @erinecon Please let me know if there's anything else I need to do.

@erinecon erinecon added the documentation Improvements or additions to documentation label Feb 2, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:42.339586+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:08.184750+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:52.338007+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:09.471731+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:38.160462

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:10.962905

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:41:45.955497+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@Thanhphan1147 Thanhphan1147 enabled auto-merge (squash) February 5, 2026 00:05
@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:42.339586+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:08.184750+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:52.338007+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:09.471731+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:38.160462

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:33:10.962905

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Test results for commit 3200ffc

Test coverage for 3200ffc

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      7      0      0     0%   8-23
----------------------------------------------------------
TOTAL              7      7      0      0     0%

Static code analysis report

Run started:2026-02-04 14:41:45.955497+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 52
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@Thanhphan1147 Thanhphan1147 merged commit f3e25ea into canonical:main Feb 5, 2026
251 of 288 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erinecon erinecon erinecon approved these changes

@Thanhphan1147 Thanhphan1147 Thanhphan1147 approved these changes

@DeeKay3 DeeKay3 Awaiting requested review from DeeKay3 DeeKay3 is a code owner automatically assigned from canonical/platform-engineering

@yhaliaw yhaliaw Awaiting requested review from yhaliaw yhaliaw is a code owner automatically assigned from canonical/platform-engineering

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jahn-junior @erinecon @Thanhphan1147