Content fixes & deploy from github action rather than classic pages (#…

…459)
apisyouwonthate · Nov 10, 2023 · 7393465 · 7393465
1 parent 0eb3814
commit 7393465
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 18 deletions.
diff --git a/.github/workflows/jekyll.yml b/.github/workflows/jekyll.yml
@@ -1,20 +1,64 @@
-name: Jekyll site CI
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll site to Pages
 
 on:
+  # Runs on pushes targeting the default branch
   push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
 
 jobs:
+  # Build job
   build:
-
     runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+        with:
+          ruby-version: '3.1' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v2
 
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
     steps:
-    - uses: actions/checkout@v3
-    - name: Build the site in the jekyll/builder container
-      run: |
-        docker run \
-        -v ${{ github.workspace }}:/srv/jekyll -v ${{ github.workspace }}/_site:/srv/jekyll/_site \
-        jekyll/builder:latest /bin/bash -c "chmod -R 777 /srv/jekyll && jekyll build --future"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
diff --git a/_data/tools.yml b/_data/tools.yml
@@ -1010,7 +1010,7 @@
 - name: Dredd
   category:
     - testing
-  link: http://dredd.io/
+  link: https://dredd.io/
   github: https://github.com/apiaryio/dredd
   language: Javascript
   description:
@@ -1052,7 +1052,7 @@
   category:
     - testing
     - converters
-  link: http://getportman.com/
+  link: https://getportman.com/
   github: https://github.com/apideck-libraries/portman
   language: Node.js
   description: "Port OpenAPI Spec to Postman Collection, with contract & variation tests included!"
@@ -1325,7 +1325,7 @@
 
 - name: psx-api
   category: parsers
-  link: http://phpsx.org
+  link: https://phpsx.org
   github: https://github.com/apioo/psx-api
   language: PHP
   description: Parse and generate API specification formats
@@ -1444,7 +1444,7 @@
 - name: NSwag
   category:
     - sdk
-  link: http://NSwag.org
+  link: https://NSwag.org
   github: https://github.com/RicoSuter/NSwag
   language: ".NET"
   description: OpenAPI toolchain for .NET, Web API and TypeScript
@@ -2136,7 +2136,7 @@
     - documentation
     - testing
   link: https://ignatandrei.github.io/BlocklyAutomation/
-  github: http://github.com/ignatandrei/BlocklyAutomation
+  github: https://github.com/ignatandrei/BlocklyAutomation
   language: Javascript / .NET
   description:
     Input any OpenAPI document to have generated Blocks in Blockly form to test and generate documentation.

diff --git a/index.html b/index.html
@@ -166,11 +166,12 @@ <h2 id="{{ category.slug }}">
               {% assign sorted_tools = sponsored_tools | concat: non_sponsored_tools %}
 
               {% for tool in sorted_tools %} {% if tool.category == category.slug or tool.category contains category.slug %}
+              {% assign url = tool.link | default: tool.github %}
               <tr class="table-row {% if tool.sponsored %}font-weight-bold alert alert-primary{% endif %}">
                 <td class="font-serif w-3/5">
                   <a
                     target="_blank"
-                    href="{% if tool.link %}{{ tool.link }}{% else %}{{ tool.github }}{% endif %}?utm_source=openapi-tools&utm_medium=website&utm_campaign=api-tools"
+                    href="{{ url }}{% if url contains '?' %}&{% else %}?{% endif %}utm_source=openapi-tools&utm_medium=website&utm_campaign=api-tools"
                   >
                     {{ tool.name }}
                   </a>
@@ -206,7 +207,7 @@ <h2 id="{{ category.slug }}">
                   {% if tool.github %}<a
                     target="_blank"
                     href="{{ tool.github }}"
-                    ><img src="/img/octocat.png" /></a
+                    ><img src="/img/octocat.png" alt="github octocat" /></a
                   >{% else %}{% endif %}
                 </td>
               </tr>