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.

Sign up for GitHub

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

Jump to bottom

Automated Cross-Repo Testing for SDKs When OpenAPI Specifications Are Updated #33

Open
tokuhirom opened this issue Oct 23, 2023 · 1 comment · Fixed by #35
Open

Automated Cross-Repo Testing for SDKs When OpenAPI Specifications Are Updated #33

tokuhirom opened this issue Oct 23, 2023 · 1 comment · Fixed by #35
Assignees
@mokuzon
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@tokuhirom
Copy link
Member

Background

This repository hosts the OpenAPI specifications that serve as the basis for various SDKs, including but not limited to Python, Node.js, and Golang. These SDKs are maintained in separate repositories, some of which are officially supported by us.

Proposal

To ensure that changes to the OpenAPI specifications do not inadvertently break these SDKs, I propose an automated testing pipeline that triggers whenever a pull request modifying the OpenAPI specs is submitted. Specifically, the pipeline would:

  1. Update the OpenAPI submodule in each officially supported SDK repository.
  2. Run the SDK tests in these repositories.
  3. Report the test results back to the original pull request in this OpenAPI repository, either as comments or through other mechanisms like GitHub Checks.

Expected Benefits

  1. Early detection of issues in the officially supported SDKs due to changes in the OpenAPI specs.
  2. Increased confidence in the robustness of both the OpenAPI specifications and the SDKs that rely on them.
  3. Streamlining of the review process by automating checks that would otherwise be manual.

I look forward to hearing your thoughts on this proposal.
@tokuhirom tokuhirom added enhancement New feature or request good first issue Good for newcomers labels Oct 23, 2023
@tokuhirom tokuhirom mentioned this issue Oct 26, 2023
Merged
tokuhirom added a commit that referenced this issue Oct 26, 2023
@tokuhirom
Run SDK test on PR (#35)
0f859b7 
Close #33
@Yang-33
Copy link
Contributor

Yang-33 commented Oct 26, 2023 •
edited
Loading

We need to support 6 SDKs finally.
(SDKs based on OpenAPI generator)

(SDKs trying to use OpenAPI generator)

  • Ruby

@Yang-33 Yang-33 reopened this Oct 26, 2023
@Yang-33 Yang-33 mentioned this issue Oct 29, 2023
Merged
Yang-33 added a commit that referenced this issue Oct 30, 2023
@Yang-33
Add test for Python, PHP, and Node.js sdks (#37)
8d9b501 
This change supports
1. checking new OAS doesn't break our sdks in advance
2. showing diffs of each sdks (for newbie to debug changes?)

Related to #33
tokuhirom added a commit that referenced this issue Oct 31, 2023
@tokuhirom
Test golang SDK on PR
4bf9ada 
#33
@tokuhirom tokuhirom mentioned this issue Oct 31, 2023
Merged
tokuhirom added a commit that referenced this issue Oct 31, 2023
@tokuhirom
Test golang SDK on PR (#38)
81a963c 
#33
@Yang-33 Yang-33 mentioned this issue Nov 25, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mokuzon mokuzon

Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Run SDK test on PR tokuhirom/line-openapi
3 participants
@tokuhirom @mokuzon @Yang-33