create-n-deploy-docs.yaml

name: Create and Deploy Docs

on:
    workflow_dispatch:
        inputs:
            branch-name:
                description: 'Branch to be used as base to create a new one to generate and be published.'
                type: string
                required: true
            delete-branch:
                description: 'Delete deploy-docs branch at the end of process.'
                type: boolean
                default: true
            run-lint:
                description: 'Compile and perform lint tests to ensure there is no issues at given branch name.'
                type: boolean
                default: true

permissions:
    contents: read

jobs:
    check-repo:
        runs-on: ubuntu-latest

        outputs:
            is-real-osui-repo: ${{ steps.check-is-real-osui-repo.outputs.isIt }}

        steps:
            - name: 🔎 Check if it's outsystems-ui real repository
              id: check-is-real-osui-repo
              run: |
                  echo "isIt=${{ github.event.repository.name == 'outsystems-ui' }}" >> "$GITHUB_OUTPUT"

    run-lint:
        runs-on: ubuntu-latest
        permissions:
            contents: read
        steps:
            - name: 📥 Checkout into ${{ inputs.branch-name }}
              uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
              with:
                  ref: ${{ inputs.branch-name }}

            - name: 🕸️ Install project dependencies
              if: ${{ inputs.run-lint == true }}
              run: npm install

            - name: 🏗️ Run build
              if: ${{ inputs.run-lint == true }}
              run: npm run build

    create-branch:
        needs: run-lint
        runs-on: ubuntu-latest
        permissions:
            id-token: write
            contents: write

        steps:
            - name: 📥 Checkout repository
              uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

            - name: 🔐 Azure Login
              uses: ./.github/actions/az-login
              with:
                client-id: ${{ secrets.OSUI_AZURE_CLIENT_ID }}
                tenant-id: ${{ secrets.OSUI_AZURE_TENANT_ID }}
                subscription-id: ${{ secrets.OSUI_AZURE_SUBSCRIPTION_ID }}

            - name: 🔑 Get GitHub Token from Azure Key Vault
              id: get-github-token
              uses: ./.github/actions/az-keyvault-get
              with:
                  key-name: o11odc-github-gitpersonal-token-prd

            - name: 📥 Checkout into ${{ inputs.branch-name }}
              uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
              with:
                  ref: ${{ inputs.branch-name }}
                  token: ${{ steps.get-github-token.outputs.az-keyvault-value }}

            - name: 📦 Create new deploy-docs branch based on ${{ inputs.branch-name }}
              run: |
                  git checkout -b deploy-docs
                  git push -u origin deploy-docs

    create-doc:
        needs: create-branch
        runs-on: ubuntu-latest
        permissions:
            id-token: write
            contents: write

        steps:
            - name: 📥 Checkout repository
              uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

            - name: 🔐 Azure Login
              uses: ./.github/actions/az-login
              with:
                client-id: ${{ secrets.OSUI_AZURE_CLIENT_ID }}
                tenant-id: ${{ secrets.OSUI_AZURE_TENANT_ID }}
                subscription-id: ${{ secrets.OSUI_AZURE_SUBSCRIPTION_ID }}

            - name: 🔑 Get GitHub Token from Azure Key Vault
              id: get-github-token
              uses: ./.github/actions/az-keyvault-get
              with:
                  key-name: o11odc-github-gitpersonal-token-prd

            - name: 🔧 Configure Git with the UiComponentsBot Token
              run: |
                  git config --global user.email "sa_git_uicomponents@outsystems.com"
                  git config --global user.name "UiComponentsBot"

            - name: 📥 Checkout into deploy-docs
              uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
              with:
                  ref: deploy-docs
                  token: ${{ steps.get-github-token.outputs.az-keyvault-value }}

            - name: 🕸️ Install project dependencies
              run: npm install

            - name: 📦 Install graphviz
              run: sudo apt install -y graphviz

            - name: 🏗️ Generate documentation
              run: npm run docs

            - name: 🔑 Get GPG Passphrase from Azure Key Vault
              id: GetGPGPassphrase
              #uses: OutSystems/rd.github-reusable-workflows/.github/actions/az-keyvault-get@9d497d1c5bc6e355aa8f4663539e6b75c212f6b4 #v2.0.7
              uses: ./.github/actions/az-keyvault-get
              with:
                  key-name: o11odc-github-gpg-passphrase-prd

            - name: 🔏 Sign and commit documentation to branch deploy-docs
              #uses: OutSystems/rd.github-reusable-workflows/.github/actions/signed-commit@9d497d1c5bc6e355aa8f4663539e6b75c212f6b4 #v2.0.7
              uses: ./.github/actions/signed-commit
              with:
                  commit-branch: deploy-docs
                  commit-message: 'Update documentation [skip ci]'
                  commit-new-files: true
                  gpg-priv-key: ${{ secrets.GPG_SIGN_KEY }}
                  # gpg-priv-key: ${{ steps.GetGPGKey.outputs.az-keyvault-value }}
                  gpg-pass-phrase: ${{ steps.GetGPGPassphrase.outputs.az-keyvault-value }}

    publish-doc:
        needs: [check-repo, create-doc]
        runs-on: ubuntu-latest
        permissions:
            id-token: write
            contents: write

        steps:
            - name: 📥 Checkout repository
              uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

            - name: 🔐 Azure Login
              uses: ./.github/actions/az-login
              with:
                client-id: ${{ secrets.OSUI_AZURE_CLIENT_ID }}
                tenant-id: ${{ secrets.OSUI_AZURE_TENANT_ID }}
                subscription-id: ${{ secrets.OSUI_AZURE_SUBSCRIPTION_ID }}

            - name: 🔑 Get GitHub Token from Azure Key Vault
              id: get-github-token
              uses: ./.github/actions/az-keyvault-get
              with:
                  key-name: o11odc-github-gitpersonal-token-prd

            - name: 📥 Checkout into deploy-docs
              uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
              with:
                  ref: deploy-docs
                  token: ${{ steps.get-github-token.outputs.az-keyvault-value }}

            - name: 📤 Push documentation files into github page
              if: ${{ needs.check-repo.outputs.is-real-osui-repo == 'true' }}
              uses: GuillaumeFalourd/copy-push-files@758ee05c45fbd682b62908f2373bf070077a1e43 # v1
              with:
                  source_files: docs/*
                  remote_repository: https://github.com/outsystems-ui-docs/outsystems-ui-docs.github.io
                  access_token: ${{ steps.get-github-token.outputs.az-keyvault-value }}
                  target_branch: main
                  commit_message: Deploy documentation.

    delete-branch:
        needs: publish-doc
        runs-on: ubuntu-latest
        permissions:
            id-token: write
            contents: write

        if: ${{ inputs.delete-branch == true }}
        steps:
            - name: 📥 Checkout branch dev
              uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
              with:
                  ref: dev

            - name: 🗑️ Delete branch deploy-docs
              shell: bash
              run: |
                  git push origin -d deploy-docs