Skip to content

Commit

Permalink
Added workflow for publishing redoc to Github Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
shadone committed Feb 4, 2024
1 parent c989ad8 commit ed692d8
Showing 1 changed file with 74 additions and 0 deletions.
74 changes: 74 additions & 0 deletions .github/workflows/redoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: redoc

on:
# Triggers the workflow on push or pull request events but only for the "main" branch
push:
branches: [ "main" ]
paths:
- '.github/workflows/redoc.yml'
- Lemmy.yaml

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# 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:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

- name: Build index.html
id: redoc-build
shell: bash
run: |
echo "Building index.html started" && \
npx redoc-cli build Lemmy.yaml --title "Lemmy Client API" && \
mv redoc-static.html index.html && \
sed -i '/<title>/a \ \ <link rel="icon" type="image/x-icon" href="images/favicon.ico">' index.html && \
echo "Building index.html finished"
- name: Deploy to GitHub Pages
# https://github.com/peaceiris/actions-gh-pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: .
force_orphan: true
exclude_assets: '.github,LICENSE,README.md'

deploy:
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
contents: read
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Setup Pages
uses: actions/configure-pages@v4

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: '.'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit ed692d8

Please sign in to comment.