Skip to content

Commit

Permalink
chore(ci): ci_writerside_docs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
csantiago132 committed Sep 30, 2024
1 parent 6b97725 commit ae782a7
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 77 deletions.
9 changes: 0 additions & 9 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,3 @@ jobs:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
run: npx semantic-release

generate-writerside-docs:
needs: pipeline
if: github.ref == 'refs/heads/main'
uses: ./.github/workflows/generate_writerside_docs.yml
secrets: inherit
with:
writerside_instance: 'Writerside/dcs'
artifact_name: 'webHelpDCS2-all.zip'
docker_version: 242.21870
73 changes: 73 additions & 0 deletions .github/workflows/ci_writerside_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: Build, Test, and Deploy Documentation

on:
push:
branches: ['main']
pull_request:
branches: ['main']
workflow_dispatch:

env:
INSTANCE: 'Writerside/dcs' # Name of the module (adjust for your project)
ARTIFACT: 'webHelpDCS2-all.zip' # Name of the artifact to be generated
DOCKER_VERSION: '242.21870' # Specific Docker version

jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }} # Ensure access to private repo
fetch-depth: 0

- name: Build docs using Writerside Docker builder
uses: JetBrains/writerside-github-action@v4
with:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
docker-version: ${{ env.DOCKER_VERSION }}

- name: Save artifact with build results
uses: actions/upload-artifact@v4
with:
name: docs
path: |
artifacts/${{ env.ARTIFACT }} # Artifact inside the artifacts folder
artifacts/report.json
retention-days: 7

- name: Unzip artifact
run: |
unzip -O UTF-8 -qq artifacts/${{ env.ARTIFACT }} -d dir
- name: Configure GitHub Pages
uses: actions/configure-pages@v4

- name: Upload artifact to GitHub Pages
uses: actions/upload-pages-artifact@v3
with:
path: dir

- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}

test:
runs-on: ubuntu-latest
needs: build-and-deploy

steps:
- name: Download artifact
uses: actions/download-artifact@v4
with:
name: docs
path: artifacts

- name: Test documentation using Writerside Checker
uses: JetBrains/writerside-checker-action@v1
with:
instance: ${{ env.INSTANCE }}
68 changes: 0 additions & 68 deletions .github/workflows/generate_writerside_docs.yml

This file was deleted.

0 comments on commit ae782a7

Please sign in to comment.