action.yml

name: "Build and Deploy Documentation Site"
description: "Convert Markdown documentation to a BCC documentation site"
inputs:
  title:
    description: "Title of the generated website"
    required: true
    default: ${{ github.event.repository.name }}
  description:
    description: "Description of the generated website, used for the head meta tag"
    required: true
    default: ${{ github.event.repository.description }}
  docs-dir:
    description: "Directory where the docs are located"
    required: false
    default: "docs"
  branch:
    description: 'Which branch to use for "Edit this page on GitHub" links'
    required: false
    default: "main"
  base:
    description: "The base url for the website"
    required: false
    default: "/"
  collapse-sidebar:
    description: "Whether to collapse sidebar sections by default"
    required: false
    default: "false"
  auto-register-components:
    description: "Whether to automatically register Vue components"
    required: false
    default: "false"
  components-dir:
    description: "The directory from where Vue components should automatically be registered"
    required: false
    default: "src/components"
  debug-build:
    description: "Whether or not to enable debugging for the Vite build"
    required: false
    default: "false"
  public:
    description: "Whether or not to make the documentation publicly available (only works for private repositories)"
    required: false
    default: "false"
  authentication:
    description: "Which provider to use for the login flow when accessing the documentation"
    required: false
    default: "github"
  root:
    description: "Whether or not to deploy the site to the root of the custom container (true) or to a subfolder named after the repository (false)"
    required: false
    default: "false"
  pat:
    description: "Personal Access Token for authentication"
    required: true
  env:
    description: "Environment to deploy to (sandbox, prod)"
    required: false
    default: "prod"
runs:
  using: "composite"
  steps:
    - name: Check out base repository
      uses: actions/checkout@v5
      with:
        repository: bcc-code/bcc-developer-docs
        ref: master
        token: ${{ inputs.pat }}

    - name: Check out current repository
      uses: actions/checkout@v5
      with:
        path: source

    - name: Zip Markdown files
      shell: bash
      run: |
        cd source/${{ inputs.docs-dir }}
        zip -r MarkdownDocs.zip .

    - name: Zip Vue components (if they exist)
      shell: bash
      run: |
        if [ -d "source/${{ inputs.components-dir }}" ]; then
          cd source/${{ inputs.components-dir }}
          zip -r VueComponents.zip .
        fi

    - name: Set domain variable
      id: set-domain
      shell: bash
      run: |
        if [ "${{ inputs.env }}" = "prod" ]; then
          echo "domain=https://developer.bcc.no" >> $GITHUB_OUTPUT
        else
          echo "domain=https://developer.sandbox.bcc.no" >> $GITHUB_OUTPUT
        fi

    - name: Get Token from GitHub
      id: token
      shell: bash
      run: |
        curl -s -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=https://github.com/bcc-code" | jq -r ".value" | echo -e "token=$(</dev/stdin)\n" >> $GITHUB_OUTPUT

    - name: Upload Markdown files to azure storage
      shell: bash
      run: |
        curl --request POST \
          --header "Authorization: Bearer ${{steps.token.outputs.token}}" \
          --header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36' \
          --form Docs=@source/${{ inputs.docs-dir }}/MarkdownDocs.zip \
          "${{ steps.set-domain.outputs.domain }}/UploadMdContainer?aggregateContainer=mddocs&root=${{inputs.root}}"

    - name: Upload Vue components to azure storage (if they exist)
      shell: bash
      run: |
        if [ -f "source/${{ inputs.components-dir }}/VueComponents.zip" ]; then
          curl --request POST \
            --header "Authorization: Bearer ${{steps.token.outputs.token}}" \
            --header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36' \
            --form Docs=@source/${{ inputs.components-dir }}/VueComponents.zip \
            "${{ steps.set-domain.outputs.domain }}/UploadDoc?isPublic=false&customContainerName=components"
        fi

    - name: Download Markdown files from azure storage
      shell: bash
      run: |
        cd vuepress/docs/
        curl --request GET \
          --header "Authorization: Bearer ${{steps.token.outputs.token}}" \
          --header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36' \
          "${{ steps.set-domain.outputs.domain }}/GetDoc?container=mddocs" \
          --output MarkdownDocs.zip
        unzip -o MarkdownDocs.zip
        rm MarkdownDocs.zip
        mv bcc-developer-docs/* .
        rm -rf bcc-developer-docs

    - name: Download Vue components from azure storage
      shell: bash
      run: |
        mkdir -p vuepress/docs/.vuepress/auto-register-components
        cd vuepress/docs/.vuepress/auto-register-components
        curl --request GET \
          --header "Authorization: Bearer ${{steps.token.outputs.token}}" \
          --header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36' \
          "${{ steps.set-domain.outputs.domain }}/GetDoc?container=components" \
          --output VueComponents.zip
        if [ -f "VueComponents.zip" ]; then
          unzip -o VueComponents.zip
          rm VueComponents.zip
        fi

    - name: Build VuePress site
      shell: bash
      run: |
        chmod -R u+rwX vuepress/docs || true
        cd vuepress
        npm i && ${{ inputs.debug-build == true && 'DEBUG=*' || '' }} npm run build ${{ inputs.debug-build == true && '-- --debug' || '' }}

    - name: Zips built site files
      shell: bash
      run: |
        cd vuepress/docs/.vuepress/dist
        zip -r Docs.zip .

    - name: Upload VuePress site
      shell: bash
      run: |
        curl --request POST \
          --header "Authorization: Bearer ${{steps.token.outputs.token}}" \
          --header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36' \
          --form Docs=@vuepress/docs/.vuepress/dist/Docs.zip \
          "${{ steps.set-domain.outputs.domain }}/UploadDoc?customContainerName=docs"