initial commit

- add api doc - add workflow to gnerate html and publish to pages
swisspost · Jul 17, 2024 · 890e5f6 · 890e5f6
commit 890e5f6
Show file tree

Hide file tree

Showing 2 changed files with 1,197 additions and 0 deletions.
diff --git a/github/workflows/redocly_and_publish.yml b/github/workflows/redocly_and_publish.yml
@@ -0,0 +1,66 @@
+name: Generate html from yml docs and publish to pages
+
+on:
+  push:
+    branches:
+    - main
+
+jobs:
+  generate_docs:
+    name: Generate HTML Docs
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/[email protected]
+
+      - name: Check for .yml files
+        run: |
+          if ls *.yml 1> /dev/null 2>&1; then
+            echo "YAML files found."
+          else
+            echo "No YAML files found. Exiting."
+            exit 1
+          fi
+
+      - name: Install Node.js
+        uses: actions/[email protected]
+
+      - name: Install Redocly CLI
+        run: npm install -g @redocly/cli
+
+      - name: Generate HTML files
+        run: |
+          for file in *.yml; do
+            redocly build-docs -o ${file%.*}.html $file
+          done
+
+      - name: Add noIndex Meta Tag
+        run: |
+          for file in *.html; do
+            if [[ -f "$file" ]]; then
+              echo "Found HTML file: $file"
+              if sed -i '/<head>/a <meta name="robots" content="noindex">' "$file"; then
+                echo "Added meta tag to $file successfully."
+              else
+                echo "Failed to add meta tag to $file."
+              fi
+            fi
+          done
+          
+        shell: bash
+
+      - name: Set up Git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "GitHub Actions"
+    
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          folder: .  # Root folder where HTML files are located