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

Fix up GitHub pages workflow. #215

Merged
merged 1 commit into from
Apr 2, 2024

Conversation

dblock
Copy link
Member

@dblock dblock commented Apr 2, 2024

Description

  1. Switches to a manual jekyll build that uses a local plugin to generate OpenAPI specs. You can now jekyll build locally and then jekyll serve and browse the docs on http://localhost:4000.
  2. Uses a custom jekyll workflow to deploy to gh-pages. This is required because custom plugins aren't supported in the automated GitHub pages process.
  3. Upgrades Swagger to 5 that supports OpenAPI 3.1.0.

Working example: https://dblock.github.io/opensearch-api-specification/
Successful workflow: https://github.com/dblock/opensearch-api-specification/actions/runs/8529927743

After this is merged, switch repo settings to publish from gh-pages. May need another commit on main or manually re-trigger the build.

Issues Resolved

Closes #214

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

github-actions bot commented Apr 2, 2024

API specs implemented for 246/649 (37%) APIs.

Copy link

github-actions bot commented Apr 2, 2024

API specs implemented for 246/649 (37%) APIs.

1 similar comment
Copy link

github-actions bot commented Apr 2, 2024

API specs implemented for 246/649 (37%) APIs.

@Xtansia Xtansia merged commit 1879553 into opensearch-project:main Apr 2, 2024
3 checks passed
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.

[BUG] https://opensearch-project.github.io/opensearch-api-specification/ is broken because of CORS
2 participants