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

docs: add htmltest verification for documentation #932

Merged
merged 4 commits into from
Mar 2, 2023

Conversation

aepfli
Copy link
Member

@aepfli aepfli commented Feb 28, 2023

Fixed HTMLTest make target, and added a verification step for GitHub Actions.

@codecov
Copy link

codecov bot commented Feb 28, 2023

Codecov Report

Merging #932 (0b534c3) into main (2761a4d) will increase coverage by 0.60%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #932      +/-   ##
==========================================
+ Coverage   58.02%   58.62%   +0.60%     
==========================================
  Files          89       97       +8     
  Lines        7076     7556     +480     
==========================================
+ Hits         4106     4430     +324     
- Misses       2821     2935     +114     
- Partials      149      191      +42     
Impacted Files Coverage Δ
klt-cert-manager/kubeutils/certificates.go 0.00% <0.00%> (ø)
...anager/controllers/keptnwebhookcontroller/certs.go 70.96% <0.00%> (ø)
klt-cert-manager/kubeutils/secret.go 67.39% <0.00%> (ø)
klt-cert-manager/eventfilter/eventfilter.go 100.00% <0.00%> (ø)
klt-cert-manager/kubeutils/query.go 100.00% <0.00%> (ø)
...llers/keptnwebhookcontroller/certificate_secret.go 85.88% <0.00%> (ø)
...rs/keptnwebhookcontroller/webhook_configuration.go 100.00% <0.00%> (ø)
...okcontroller/keptnwebhookcertificate_controller.go 52.00% <0.00%> (ø)
Flag Coverage Δ
component-tests 42.30% <ø> (ø)
keptn-lifecycle-operator 54.69% <ø> (ø)
klt-cert-manager 67.50% <ø> (?)
scheduler 21.17% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Fixed HTMLTest make target, and added a verification step for
GitHub Actions.

Signed-off-by: Simon Schrottner <[email protected]>
@aepfli
Copy link
Member Author

aepfli commented Feb 28, 2023

currently the build fails for following issues, i will check if this is something fix worthy

docs/crd-ref/lifecycle/v1alpha2/index.html
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha2/index.html --> #keptnevaluationstatus
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha2/index.html --> #keptntaskdefinitionstatus
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha2/index.html --> #keptnappversionstatus
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha2/index.html --> #keptnworkloadinstancestatus
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha2/index.html --> #keptnappversionstatus
docs/crd-ref/lifecycle/v1alpha1/index.html
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha1/index.html --> #keptnappversionstatus
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha1/index.html --> #keptnworkloadinstancestatus
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha1/index.html --> #keptnevaluationstatus
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha1/index.html --> #keptntaskdefinitionstatus
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha1/index.html --> #keptnappversionstatus
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha1/index.html --> #keptnworkloadinstancestatus
  hash does not exist --- docs/crd-ref/lifecycle/v1alpha1/index.html --> #keptnappversionstatus

Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
@aepfli aepfli marked this pull request as ready for review February 28, 2023 14:44
Signed-off-by: Simon Schrottner <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented Mar 1, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@aepfli
Copy link
Member Author

aepfli commented Mar 1, 2023

@StackScribe @thisthat @thschue @mowies - your input would be highly appreciated

@aepfli aepfli mentioned this pull request Mar 1, 2023
10 tasks
Copy link
Member

@thisthat thisthat left a comment

Choose a reason for hiding this comment

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

LGTM

@aepfli aepfli added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 1, 2023
@mowies
Copy link
Member

mowies commented Mar 2, 2023

I don't know what to do with the failing links right now. Status objects are not rendered into the CRD docs, because they are not really needed but the link seem to still be rendered. But I don't link ignore the generated files altogether since we will add other links in there that should be checked.

@aepfli
Copy link
Member Author

aepfli commented Mar 2, 2023

I suggest we merge it, with the current configuration and create a follow up to take a look at crd-ref-docs.

I think html test adds more benefit, as it would bring us to find a crd-ref solution immediately.

WDYT?

@mowies
Copy link
Member

mowies commented Mar 2, 2023

If merging means that all master builds are red then I'm not voting for it 😓

Copy link
Contributor

@thschue thschue left a comment

Choose a reason for hiding this comment

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

lgtm

@thschue thschue merged commit f342ccc into keptn:main Mar 2, 2023
@keptn-bot keptn-bot mentioned this pull request Mar 2, 2023
@aepfli
Copy link
Member Author

aepfli commented Mar 2, 2023

no worries @mowies, i excluded the lifecyle crd ref for now within the .htmltest.yml file - we can add more any time

@keptn-bot keptn-bot mentioned this pull request Mar 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants