Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate navigation table #217

Merged
merged 11 commits into from
Oct 12, 2023
Merged

Migrate navigation table #217

merged 11 commits into from
Oct 12, 2023

Conversation

jdkandersson
Copy link
Contributor

Applicable spec: https://discourse.charmhub.io/t/specification-isd003-upload-charm-docs-contents-index-and-navigation-table/7986

Overview

Generates the contents index from the navigation table during migration

Rationale

so that the navigation table is now also fully managed

Module Changes

The migrate module has been changed to generate the contents index during migration

Checklist

  • The contributing guide was applied
  • The documentation is generated using src-docs
  • The PR is tagged with appropriate label (urgent, trivial, complex)
  • Changelog has been updated
  • Version has been incremented

Version to be incremented on release to stable

@jdkandersson jdkandersson marked this pull request as ready for review September 28, 2023 06:38
@jdkandersson jdkandersson requested a review from a team as a code owner September 28, 2023 06:38
@github-actions
Copy link

Test coverage for c4c46fe

Name                      Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------------
src/__init__.py              83      0     34      0   100%
src/action.py               155      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             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               196      0     54      0   100%
---------------------------------------------------------------------
TOTAL                      1618      0    516      0   100%

Static code analysis report

Working... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:02
Run started:2023-10-10 02:38:51.065118

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 17294
  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):

src/migration.py Show resolved Hide resolved
src/navigation_table.py Show resolved Hide resolved
@jdkandersson jdkandersson merged commit c9d643b into main Oct 12, 2023
23 checks passed
@jdkandersson jdkandersson deleted the migrate-navigation-table branch October 12, 2023 05:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants