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

fix(ci): autodoc was passing when it should not have been #8901

Merged
merged 2 commits into from
Jul 21, 2022

Conversation

hutchic
Copy link
Contributor

@hutchic hutchic commented Jun 3, 2022

Summary

the autodoc CI test is passing when it should not be ( https://github.com/Kong/kong/runs/6726254426?check_suite_focus=true#step:7:15 ).

This PR makes it fail "correctly" aka if the autodoc fails CI will fail as intended

I'll leave the exercise to other to make the documentation fixes required to pass this PR.

@hutchic hutchic requested a review from a team as a code owner June 3, 2022 17:23
scripts/autodoc Show resolved Hide resolved
@kikito
Copy link
Member

kikito commented Jun 3, 2022

I am pretty certain that this was my mistake. The autodocs script started its life as a manually-executed script, whose output would always be read by a human. I didn't think about the machines then. And later, when we added the ci check, I didn't remember that I had not thought about the machines.

Consider this a 👍 to the scripting change.

@flrgh Please add the upstreams.hash_on_query_arg docs so this passes.

just turn on errexit/set -e

I think we could add it. Our CI is already kind of flaky, though. Not feeling strongly either way. If you want to give it a try, I would suggest you give set -e a try, run the tests 2 or 3 times, and if you get any red, rollback to Colin's. Your call.

scripts/autodoc Outdated Show resolved Hide resolved
@flrgh
Copy link
Contributor

flrgh commented Jun 3, 2022

Added the missing docs in #8903 and tested locally with success.

Co-authored-by: Michael Martin <[email protected]>
@aboudreault aboudreault merged commit f2f7075 into master Jul 21, 2022
@aboudreault aboudreault deleted the fix/ci-autodoc branch July 21, 2022 18:13
locao pushed a commit that referenced this pull request Apr 24, 2024
- **autossl:** log the errors on the list certificates request ([#110](fffonion/lua-resty-acme#110)) [6c9760f](fffonion/lua-resty-acme@6c9760f)

- **autossl:** add option to delete none whitelisted domains in certificate renewal ([#112](fffonion/lua-resty-acme#112)) [1bbf39c](fffonion/lua-resty-acme@1bbf39c)

Cherry-picked from #12909

KAG-4330

Signed-off-by: Aapo Talvensaari <[email protected]>
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.

5 participants