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

tests(helpers): support ldoc generation #13636

Merged
merged 2 commits into from
Sep 11, 2024
Merged

tests(helpers): support ldoc generation #13636

merged 2 commits into from
Sep 11, 2024

Conversation

chronolaw
Copy link
Contributor

@chronolaw chronolaw commented Sep 9, 2024

Summary

KAG-5333, support ldoc generation.

  • edit config.ld, add directory ./details and merge=true
  • add @module header for separated test modules

Checklist

  • The Pull Request has tests
  • A changelog file has been created under changelog/unreleased/kong or skip-changelog label added on PR if changelog is unnecessary. README.md
  • There is a user-facing docs PR against https://github.com/Kong/docs.konghq.com - PUT DOCS PR HERE

Issue reference

Fix #[issue number]

@github-actions github-actions bot added the cherry-pick kong-ee schedule this PR for cherry-picking to kong/kong-ee label Sep 9, 2024
@chronolaw chronolaw changed the title Tests/helpers ldoc fix tests(helpers): support ldoc generation Sep 9, 2024
@chronolaw chronolaw requested a review from Tieske September 9, 2024 02:39
@chronolaw
Copy link
Contributor Author

@Tieske , could you take a look? thanks.

@pull-request-size pull-request-size bot added size/M and removed size/S labels Sep 9, 2024
@Tieske
Copy link
Member

Tieske commented Sep 9, 2024

added some minor fixes.

what strikes me is that the section "Custom assertions" contains a ton of unrelated stuff, eg. start_kong used to be located under "shell helpers"?

@Tieske
Copy link
Member

Tieske commented Sep 9, 2024

fyi: the spec/renderdocs.sh scripts can be used to re-render docs on the fly while editing them.

@chronolaw
Copy link
Contributor Author

added some minor fixes.

what strikes me is that the section "Custom assertions" contains a ton of unrelated stuff, eg. start_kong used to be located under "shell helpers"?

We could fix these concerns later, now we will focus on module splitting.

@chronolaw chronolaw force-pushed the tests/helpers_ldoc_fix branch from a96b6fc to e4123da Compare September 10, 2024 05:49
@pull-request-size pull-request-size bot added size/S and removed size/M labels Sep 10, 2024
@ADD-SP ADD-SP merged commit 057a0b8 into master Sep 11, 2024
33 checks passed
@ADD-SP ADD-SP deleted the tests/helpers_ldoc_fix branch September 11, 2024 07:49
@team-gateway-bot
Copy link
Collaborator

Cherry-pick failed for master, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally.

git remote add upstream https://github.com/kong/kong-ee
git fetch upstream master
git worktree add -d .worktree/cherry-pick-13636-to-master-to-upstream upstream/master
cd .worktree/cherry-pick-13636-to-master-to-upstream
git checkout -b cherry-pick-13636-to-master-to-upstream
ancref=$(git merge-base 5ac6e1e541dd9d7219044f500b7954892c49dcf0 e4123dab32b50ae26f50a0f7ba9d3e2e6aef0143)
git cherry-pick -x $ancref..e4123dab32b50ae26f50a0f7ba9d3e2e6aef0143

@github-actions github-actions bot added the incomplete-cherry-pick A cherry-pick was incomplete and needs manual intervention label Sep 11, 2024
@AndyZhang0707 AndyZhang0707 removed the incomplete-cherry-pick A cherry-pick was incomplete and needs manual intervention label Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherry-pick kong-ee schedule this PR for cherry-picking to kong/kong-ee size/S skip-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants