Skip to content

CI should have a step to generate API types for typescript and compare with the committed file for differences #2427

Open
@antoinemzs

Description

@antoinemzs

Context

Use case

Regenerating the API types file may be forgotten in some situations, leading to a potential discrepancy between the typescript proxies and the Java spec.

The CI should act as an early canary that running yarn generate-aip-types-from-api was potentially not run before committing changes by running it itself and checking if there are differnces with the commited file.

Current Workaround

No real workaround; discrepancies may be discovered by accident in other branches.

Proposed Solution

CI step:

  • run the yarn job
  • check if there are changes compared to the commited file:
    • yes: fail run
    • no: continue

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureuse for describing a new feature to developtechnical improvementTechnical refactor or improvement is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions