deployment.yml

name: Deploy the Greenbone Documentation

on:
  workflow_call:
    inputs:
      doc_root:
        required: true
        default: "latest"
        type: string
      artifact_name:
        default: "greenbone-community-docs"
        required: true
        type: string

permissions:
  contents: write
  id-token: write
  pages: write

jobs:
  deploy-docs:
    name: Deploy Documentation to GitHub Pages
    runs-on: 'ubuntu-latest'
    concurrency:
      group: github-pages
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: greenbone/actions/checkout@v3
        id: checkout
        with:
          ref: "gh-pages"
      - name: Cleanup Document Root
        run: |
          rm -rf ${{ inputs.doc_root }}
          mkdir -p ${{ inputs.doc_root }}
      - name: Download Documentation Artifact
        uses: actions/download-artifact@v4
        with:
          name: ${{inputs.artifact_name }}
          path: ${{ inputs.doc_root }}
      - name: Create GitHub Pages
        run: |
          git config --global user.name "${GITHUB_ACTOR}"
          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
          git add ${{ inputs.doc_root }}
          git commit --amend -m "Updating Docs for commit ${{ steps.checkout.outputs.sha }}"
          git push --force-with-lease
      - name: Upload pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: .
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4
      - name: Job Summary
        run: |
          echo '### Deployment successful! :rocket: https://greenbone.github.io/docs/${{ inputs.doc_root }}' >> $GITHUB_STEP_SUMMARY