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

Add respec workflow #55

Merged
merged 17 commits into from
Sep 11, 2024
Merged

Add respec workflow #55

merged 17 commits into from
Sep 11, 2024

Conversation

ralfhandl
Copy link
Contributor

@ralfhandl ralfhandl commented Sep 9, 2024

Adds workflow to regenerate HTML versions of the Overlay specification

To Do for follow-up PR:

  • Create PRs in OAI/OpenAPI-Specification repo once Overlay 1.0 is released

Currently PRs will be created in

and will deploy to

which allows us to proof-read the respec-formatted HTML.

mikekistler
mikekistler previously approved these changes Sep 10, 2024
Copy link
Contributor

@mikekistler mikekistler 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. 👍

(with the qualification that TODOs are fixed before merge)

@ralfhandl
Copy link
Contributor Author

TODOs are fixed before merge

TODOs that can be fixed before the release have been fixed.

Copy link
Contributor

@mikekistler mikekistler 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! 👍

- uses: actions/checkout@v4 # checkout gh-pages branch
with:
token: ${{ secrets.OAS_REPO_TOKEN }}
repository: ralfhandl/OpenAPI-Specification # TODO: change to OAI/...
Copy link
Contributor

Choose a reason for hiding this comment

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

Based on your comment, I assume that means this TODO must be fixed after merge. I'll take your word on that ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Correct, otherwise we'd open PRs in https://github.com/OAI/OpenAPI-Specification/pulls for publishing the Overlay specification on https://spec.openapis.org/, which we probably don't want before we release v1.0.

@ralfhandl ralfhandl merged commit 9cb7a8c into OAI:main Sep 11, 2024
1 check passed
@ralfhandl ralfhandl deleted the respec-workflow branch September 11, 2024 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants