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

Chore: Fix script to generate reference page of custom resources in docs #5232

Merged
merged 1 commit into from
Nov 24, 2023

Conversation

randmonkey
Copy link
Contributor

What this PR does / why we need it:

Fixes the script to generate reference page of custom resources in the docs repo.
create docs PR job run on the branch: https://github.com/Kong/kubernetes-ingress-controller/actions/runs/6977712012

Which issue this PR fixes:

Special notes for your reviewer:

PR Readiness Checklist:

Complete these before marking the PR as ready to review:

- [ ] the CHANGELOG.md release notes have been updated to reflect any significant (and particularly user-facing) changes introduced by this PR

Copy link

codecov bot commented Nov 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (63253d7) 76.8% compared to head (4220b91) 76.8%.
Report is 15 commits behind head on main.

❗ Current head 4220b91 differs from pull request most recent head 9155c44. Consider uploading reports for the commit 9155c44 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##            main   #5232     +/-   ##
=======================================
- Coverage   76.8%   76.8%   -0.1%     
=======================================
  Files        170     170             
  Lines      19050   19056      +6     
=======================================
- Hits       14649   14644      -5     
- Misses      3575    3586     +11     
  Partials     826     826             

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@czeslavo
Copy link
Contributor

Why change from include to inlcude_cached? I recently changed that to include to match manual edits on docs.konghq.com side (I believe they were made for a reason there, not sure though what was it exactly).

@randmonkey
Copy link
Contributor Author

Why change from include to inlcude_cached? I recently changed that to include to match manual edits on docs.konghq.com side (I believe they were made for a reason there, not sure though what was it exactly).

It was just a revert of the original change in #5094. According to the README in docs repo https://github.com/Kong/docs.konghq.com/blob/main/README.md#include-check, The include_cache is only required when referencing page variables in _include files, so it is OK to use include.

@randmonkey
Copy link
Contributor Author

@randmonkey randmonkey enabled auto-merge (squash) November 24, 2023 08:18
@randmonkey randmonkey merged commit 250c634 into main Nov 24, 2023
36 checks passed
@randmonkey randmonkey deleted the chore/fix_release_docs_scripts branch November 24, 2023 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants