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

Management API: add workflow to assert version bump #4182

Open
Tracked by #4180
paullatzelsperger opened this issue May 15, 2024 · 1 comment
Open
Tracked by #4180

Management API: add workflow to assert version bump #4182

paullatzelsperger opened this issue May 15, 2024 · 1 comment
Labels
triage all new issues awaiting classification
Milestone
Milestone 16

Comments

@paullatzelsperger
Copy link
Member

paullatzelsperger commented May 15, 2024 •
edited

WHAT

add a GitHub workflow that checks that the version information file (#4181) was changed if a Management API module changed.

WHY

Every change to the API must increment the version.

HOW

One way could be a workflow that is only triggered on changes within extensions/control-plane/api/managment-api directory, and that inspects the PR's changeset if it contains the version.json file
@paullatzelsperger paullatzelsperger mentioned this issue May 15, 2024
Open
5 tasks
@github-actions github-actions bot added the triage all new issues awaiting classification label May 15, 2024
@paullatzelsperger paullatzelsperger changed the title [optional] add a GitHub workflow check to assert that the version file changed if a management API module changed. Every change to the API must increment the version. Management API: add workflow to assert version bump May 15, 2024
@paullatzelsperger paullatzelsperger added this to the Milestone 16 milestone May 15, 2024
@ndr-brt
Copy link
Member

ndr-brt commented May 16, 2024

could the job based on the generated openapi file instead? otherwise any change to any other file could cause the version to change, but that shouldn't be the case.
It could be compared with the one in the gh-pages branch

@paullatzelsperger paullatzelsperger mentioned this issue May 18, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
triage all new issues awaiting classification
Projects
None yet
Milestone
Milestone 16
Development

No branches or pull requests
2 participants
@ndr-brt @paullatzelsperger