mirror of
https://github.com/knightcrawler-stremio/knightcrawler.git
synced 2024-12-20 03:29:51 +00:00
87 lines
1.9 KiB
YAML
87 lines
1.9 KiB
YAML
name: Build documentation
|
|
|
|
# TODO: Only run on ./docs folder change
|
|
|
|
on:
|
|
push:
|
|
branches: ["master"]
|
|
paths:
|
|
- 'docs/**'
|
|
# Specify to run a workflow manually from the Actions tab on GitHub
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
id-token: write
|
|
pages: write
|
|
|
|
env:
|
|
INSTANCE: Writerside/kc
|
|
ARTIFACT: webHelpKC2-all.zip
|
|
DOCS_FOLDER: ./docs
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Build Writerside docs using Docker
|
|
uses: JetBrains/writerside-github-action@v4
|
|
with:
|
|
instance: ${{ env.INSTANCE }}
|
|
artifact: ${{ env.ARTIFACT }}
|
|
location: ${{ env.DOCS_FOLDER }}
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-artifact@v3
|
|
with:
|
|
name: docs
|
|
path: |
|
|
artifacts/${{ env.ARTIFACT }}
|
|
artifacts/report.json
|
|
retention-days: 7
|
|
|
|
test:
|
|
needs: build
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Download artifacts
|
|
uses: actions/download-artifact@v3
|
|
with:
|
|
name: docs
|
|
path: artifacts
|
|
|
|
- name: Test documentation
|
|
uses: JetBrains/writerside-checker-action@v1
|
|
with:
|
|
instance: ${{ env.INSTANCE }}
|
|
|
|
deploy:
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
needs: [build, test]
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Download artifacts
|
|
uses: actions/download-artifact@v3
|
|
with:
|
|
name: docs
|
|
|
|
- name: Unzip artifact
|
|
run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir
|
|
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v4
|
|
|
|
- name: Package and upload Pages artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: dir
|
|
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|