Customize GitHub pages workflow. (#215)

dblock · web-flow · commit 18795533eac7 · 2024-04-03T11:56:10.000+13:00
Signed-off-by: dblock &lt;dblock@amazon.com&gt;
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,44 @@
+# deploys to https://opensearch-project.github.io/opensearch-api-specification/
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '20'
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+
+      - name: Build with Jekyll
+        run: |-
+          gem install jekyll
+          jekyll build
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: _site
+          branch: gh-pages
+
diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,7 @@ node_modules
 .idea/
 
 # VSCode files
-.vscode/
+.vscode/
+
+# Jekyll Website
+_site/
diff --git a/PUBLISHING_SPECS.md b/PUBLISHING_SPECS.md
@@ -3,4 +3,4 @@
 ## Publishing OpenSearch API Specs
 
 * The [build](.github/workflows/build.yml) workflow publishes [a release draft](https://github.com/opensearch-project/opensearch-api-specification/releases) whenever a change is pushed to `main`.
-* The updated OpenAPI specs are hosted on GitHub pages at https://opensearch-project.github.io/opensearch-api-specification/.
+* The [deploy](.github/workflows/deploy.yml) workflow publishes specs to [GitHub pages](https://opensearch-project.github.io/opensearch-api-specification/).
diff --git a/_config.yml b/_config.yml
@@ -0,0 +1,9 @@
+source: .
+destination: ./_site
+include:
+  - index.html
+  - favicon.ico
+exclude:
+  - '*'
+keep_files:
+  - opensearch-openapi.yaml
diff --git a/_plugins/openapi.rb b/_plugins/openapi.rb
@@ -0,0 +1,16 @@
+module OpenAPI
+  def self.generate(_site, _payload)
+    return if @generated
+
+    Dir.chdir('tools') do
+      system 'npm install'
+      system 'npm run merge -- ../spec/opensearch-openapi.yaml ../_site/opensearch-openapi.yaml'
+    end
+
+    @generated = true
+  end
+end
+
+Jekyll::Hooks.register :site, :post_write do |site, payload|
+  OpenAPI.generate(site, payload)
+end
diff --git a/favicon.ico b/favicon.ico
diff --git a/index.html b/index.html
@@ -1,29 +1,30 @@
 <html>
-    <head>
-        <!-- Load the latest Swagger UI code and style from npm using unpkg.com -->
-        <script src="https://unpkg.com/swagger-ui-dist@4/swagger-ui-bundle.js"></script>
-        <link rel="stylesheet" type="text/css" href="https://unpkg.com/swagger-ui-dist@4/swagger-ui.css"/>
-        <title>OpenSearch API Spec</title>
-    </head>
-    <body>
-        <div id="swagger-ui"></div> <!-- Div to hold the UI component -->
-        <script>
-            window.onload = function () {
-                // Begin Swagger UI call region
-                const ui = SwaggerUIBundle({
-                    url: "https://github.com/opensearch-project/opensearch-api-specification/releases/download/main/opensearch-openapi.yaml",
-                    dom_id: '#swagger-ui',
-                    deepLinking: true,
-                    presets: [
-                        SwaggerUIBundle.presets.apis,
-                        SwaggerUIBundle.SwaggerUIStandalonePreset
-                    ],
-                    plugins: [
-                        SwaggerUIBundle.plugins.DownloadUrl
-                    ],
-                })
-                window.ui = ui
-            }
-        </script>
-    </body>
-</html>
+
+<head>
+    <script src="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
+    <link rel="stylesheet" type="text/css" href="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css" />
+    <title>OpenSearch API Spec</title>
+</head>
+
+<body>
+    <div id="swagger-ui"></div>
+    <script>
+        window.onload = function () {
+            const ui = SwaggerUIBundle({
+                url: "opensearch-openapi.yaml",
+                dom_id: "#swagger-ui",
+                deepLinking: true,
+                presets: [
+                    SwaggerUIBundle.presets.apis,
+                    SwaggerUIBundle.SwaggerUIStandalonePreset
+                ],
+                plugins: [
+                    SwaggerUIBundle.plugins.DownloadUrl
+                ],
+            })
+            window.ui = ui
+        }
+    </script>
+</body>
+
+</html>
