Skip to content

docs: deploy docs to target env #16

docs: deploy docs to target env

docs: deploy docs to target env #16

Workflow file for this run

name: Build & upload documentation
on:
push:
branches: ["main"]
env:
INSTANCE: 'web/g'
ARTIFACT: 'webHelpG2-all.zip'
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build docs using Writerside Docker builder
uses: JetBrains/writerside-github-action@v4
with:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
location: ./docs
- name: Save artifact with build results
uses: actions/upload-artifact@v4
with:
name: docs
path: |
artifacts/${{ env.ARTIFACT }}
artifacts/report.json
retention-days: 7
test-docs:
needs: build-docs
runs-on: ubuntu-latest
steps:
- name: Download artifacts
uses: actions/download-artifact@v4
with:
name: docs
path: artifacts
- name: Test documentation
uses: JetBrains/writerside-checker-action@v1
with:
instance: ${{ env.INSTANCE }}
deploy:
needs:
- build-docs
- test-docs
runs-on: ubuntu-latest
steps:
- name: Download artifacts
uses: actions/download-artifact@v4
with:
name: docs
- name: Unzip artifact
run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d docs-dist
- name: Copy files to the s3 website content bucket
run:
aws s3 sync docs-dist s3://${{ secrets.GARAGE_BUCKET_NAME }} --delete
env:
AWS_ACCESS_KEY_ID: ${{ secrets.GARAGE_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.GARAGE_SECRET_ACCESS_KEY }}
AWS_DEFAULT_REGION: hel1
AWS_ENDPOINT_URL: ${{ secrets.GARAGE_ENDPOINT }}