canonical / discourse-gatekeeper

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

Fix whitespace buildup #225

Closed jdkandersson closed 8 months ago

jdkandersson commented 8 months ago

Applicable spec: N/A

Overview

Strips whitespace around user input content to avoid whitespace accumulation

Rationale

Currently there is an issue where whitespace builds up continuously as it is not stripped from generated content before being added again.

Module Changes

N/A

Checklist

Version will be incremented on release

deusebio commented 8 months ago

The E2E tests seem to be happy about this change:

https://github.com/deusebio/gatekeeper-repo-test/actions/runs/7016270139/job/19087131474

github-actions[bot] commented 8 months ago

Test coverage for c0ee30da4b7769319a4b61401638dd825965e3c8

Name                      Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------------
src/__init__.py              91      0     36      0   100%
src/action.py               155      0     46      0   100%
src/check.py                 67      0     27      0   100%
src/clients.py               12      0      0      0   100%
src/commit.py                42      0     12      0   100%
src/constants.py             10      0      0      0   100%
src/content.py               50      0     10      0   100%
src/discourse.py            159      0     34      0   100%
src/docs_directory.py        33      0      8      0   100%
src/download.py              23      0      2      0   100%
src/exceptions.py            15      0      0      0   100%
src/index.py                142      0     56      0   100%
src/metadata.py              28      0     12      0   100%
src/migration.py            102      0     33      0   100%
src/navigation_table.py      65      0     20      0   100%
src/reconcile.py            123      0     60      0   100%
src/repository.py           284      0     88      0   100%
src/sort.py                  43      0     26      0   100%
src/types_.py               199      0     54      0   100%
---------------------------------------------------------------------
TOTAL                      1643      0    524      0   100%

Static code analysis report

Working... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:01
Run started:2023-11-30 01:47:02.645742

Test results:
    No issues identified.

Code scanned:
    Total lines of code: 17554
    Total lines skipped (#nosec): 3
    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):
jdkandersson commented 8 months ago

Ok, everything passes now 💪