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

Use tag name as the OpenAPI definition version #1561

Merged
merged 2 commits into from
Jun 20, 2023

Conversation

zecakeh
Copy link
Contributor

@zecakeh zecakeh commented Jun 9, 2023

I wanted to fix the spec version displayed in the Matrix API Viewer, which is set to "unstable" although I'm pretty sure it is only deployed for releases.

However I'm not sure how the OpenAPI definitions are deployed. My guess is that they use the artifact from the job triggered by tagging the release so this changes the CI script to use the tag name as the version, when it is available.

It might not fix what I want but at least it's not wrong 🙂.

Preview: https://pr1561--matrix-spec-previews.netlify.app

@zecakeh zecakeh requested a review from a team as a code owner June 9, 2023 13:49
Signed-off-by: Kévin Commaille <[email protected]>
@richvdh
Copy link
Member

richvdh commented Jun 20, 2023

However I'm not sure how the OpenAPI definitions are deployed. My guess is that they use the artifact from the job triggered by tagging the release so this changes the CI script to use the tag name as the version, when it is available.

Yes, that's right. It's actually a manual job to download the artifact from Github and upload it to the web server. Releases don't happen often enough for us to have automated it :)

Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

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

lgtm

@richvdh richvdh merged commit 4a9bda9 into matrix-org:main Jun 20, 2023
@zecakeh zecakeh deleted the openapi-version branch September 12, 2023 10:11
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