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

Include hand crafted resources in documentation indexes #3055

Merged
merged 19 commits into from
Jun 12, 2023

Conversation

theunrepentantgeek
Copy link
Member

What this PR does / why we need it:

Our index pages need to include any hand-crafted types that we add to ASO; without them, the documentation (which we are generating) can't be easily found.

Closes #3054

How does this PR make you feel:
gif

If applicable:

  • this PR contains tests

@theunrepentantgeek theunrepentantgeek self-assigned this Jun 8, 2023
@theunrepentantgeek theunrepentantgeek added this to the v2.2.0 milestone Jun 8, 2023
@theunrepentantgeek theunrepentantgeek changed the title Feature/index handcrafted resources Include hand crafted resources in documentation indexes Jun 8, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jun 8, 2023

Codecov Report

Merging #3055 (65a6814) into main (52d94c8) will decrease coverage by 0.02%.
The diff coverage is 74.33%.

@@            Coverage Diff             @@
##             main    #3055      +/-   ##
==========================================
- Coverage   54.27%   54.26%   -0.02%     
==========================================
  Files        1379     1379              
  Lines      596286   596347      +61     
==========================================
- Hits       323664   323605      -59     
- Misses     219482   219575      +93     
- Partials    53140    53167      +27     
Impacted Files Coverage Δ
...peline/create_types_for_backwards_compatibility.go 39.17% <ø> (+0.17%) ⬆️
...ator/internal/config/object_model_configuration.go 71.42% <53.33%> (-1.37%) ⬇️
...ernal/codegen/pipeline/report_resource_versions.go 52.36% <76.92%> (+0.44%) ⬆️
v2/internal/set/set.go 90.24% <100.00%> (+4.03%) ⬆️
...generator/internal/config/configuration_visitor.go 91.22% <100.00%> (+4.95%) ⬆️

... and 29 files with indirect coverage changes

Copy link
Member

@matthchr matthchr left a comment

Choose a reason for hiding this comment

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

Overall LGTM. One question is if there's a way for us to detect that somebody has forgotten to include a handcrafted resource in the azure-arm.yaml file?

Doesn't necessarily have to be part of the code generator (in fact in some ways that'd be sorta weird). Maybe some way to write a taskfile target that verifies this?

The more I think about it the more I wonder if we should split the doc generation out into a different tool that does something based more on the filesystem (which would then work more easily for handcrafted resources as they also exist on the filesystem)... something to think about longer term possibly.

@@ -938,6 +938,9 @@ objectModelConfiguration:
$exportAs: Database
$supportedFrom: v2.0.0-beta.1
dbformysql:
v1: # Handcrafted
Copy link
Member

Choose a reason for hiding this comment

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

Do we have a way to detect if we've forgotten to add this?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not sure at the moment. I'll give that some thought though.

@theunrepentantgeek theunrepentantgeek enabled auto-merge (squash) June 12, 2023 01:50
@theunrepentantgeek theunrepentantgeek merged commit b9c36cb into main Jun 12, 2023
@theunrepentantgeek theunrepentantgeek deleted the feature/index-handcrafted-resources branch June 12, 2023 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Bug: Hand coded resources are omitted from CRD Documentation
3 participants