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

ci(workflow): add pull request trigger sdk generation and cleanup artifacts step #1609

Merged
merged 3 commits into from
Jan 8, 2025

Conversation

Junjiequan
Copy link
Contributor

@Junjiequan Junjiequan commented Jan 8, 2025

Description

This PR resolves SDK generation issues caused by incorrect @ApiProperty definitions in DTOs and enhances workflows to ensure SDK generation is validated during pull requests.

Workflow Changes:

  • Added support for triggering workflows on pull_request events targeting the master branch.
  • Ensures SDK generation is tested as part of the CI workflow for pull requests.

DTO Refactoring:

  • Fixed @ApiProperty definitions in UpdateDatasetDto:
    • Changed type: [String] to type: String with isArray: true to resolve SDK generation issues.
    • Improved descriptions and default values to align with Swagger and SDK requirements.

Motivation

We want to ensure better testing coverage during development by validating SDK generation in pull requests. This helps catch issues early, such as the previously encountered problem with incorrect @ApiProperty definitions (type: [String]), which caused SDK generation failures.

Fixes

  • Bug fixed (#X)

Changes:

  • changes made

Tests included

  • Included for each change/fix?
  • Passing?

Documentation

  • swagger documentation updated (required for API changes)
  • official documentation updated

official documentation info

@Junjiequan Junjiequan requested a review from emigun January 8, 2025 13:07
Copy link
Contributor

@emigun emigun left a comment

Choose a reason for hiding this comment

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

Looks good!

@Junjiequan Junjiequan merged commit e4a6903 into master Jan 8, 2025
16 checks passed
@Junjiequan Junjiequan deleted the add-checks-for-the-sdk-generation branch January 8, 2025 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants