canonical / discourse-gatekeeper

Experimental GitHub Action to upload charm documentation to charmhub
Apache License 2.0
7 stars 7 forks source link

Local contents index #186

Closed jdkandersson closed 1 year ago

jdkandersson commented 1 year ago

Adds support for having a contents index locally. Based on https://discourse.charmhub.io/t/specification-isd003-upload-charm-docs-contents-index-and-navigation-table/7986

github-actions[bot] commented 1 year ago

Test coverage for 9345f8e2ea970f8fea6c6244df95a646987e6838

Name                      Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------------
src/__init__.py              61      0     22      0   100%
src/action.py               154      0     46      0   100%
src/check.py                 53      0     21      0   100%
src/clients.py               12      0      0      0   100%
src/commit.py                42      0     12      0   100%
src/constants.py              8      0      0      0   100%
src/content.py               50      0     10      0   100%
src/discourse.py            156      0     34      0   100%
src/docs_directory.py        33      0      8      0   100%
src/download.py              23      0      2      0   100%
src/exceptions.py            14      0      0      0   100%
src/index.py                120      0     42      0   100%
src/metadata.py              28      0     12      0   100%
src/migration.py             87      0     27      0   100%
src/navigation_table.py      63      0     20      0   100%
src/reconcile.py             87      0     38      0   100%
src/repository.py           268      0     82      0   100%
src/sort.py                  38      0     22      0   100%
src/types_.py               130      0     22      0   100%
---------------------------------------------------------------------
TOTAL                      1427      0    420      0   100%

Static code analysis report

Working... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:02
Run started:2023-07-13 15:00:46.312922

Test results:
    No issues identified.

Code scanned:
    Total lines of code: 14115
    Total lines skipped (#nosec): 14
    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):