Skip to content

Added workflow for publishing redoc to Github Pages #1

Added workflow for publishing redoc to Github Pages

Added workflow for publishing redoc to Github Pages #1

Workflow file for this run

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:
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:
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: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4