docs.yaml

name: techdocs

on:
  workflow_dispatch:
  push:
    paths:
      - '.github/workflows/docs.yaml'
      - 'techdocs/**'
      - 'catalog-info.yaml'
    branches:
      - main

jobs:
  docs-build:
    runs-on: ubuntu-latest
    # The following secrets are required in your CI environment for publishing files to AWS S3.
    # e.g. You can use GitHub Organization secrets to set them for all existing and new repositories.
    env:
      TECHDOCS_S3_BUCKET_NAME: ${{ secrets.TECHDOCS_S3_BUCKET_NAME }}
      AWS_ACCESS_KEY_ID: ${{ secrets.BACKSTAGE_ACCESS_KEY }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.BACKSTAGE_ACCESS_SECRET }}
      AWS_REGION: 'us-east-1'
      ENTITY_NAMESPACE: 'default'
      ENTITY_KIND: 'Component'
      ENTITY_NAME: 'python-rds-ref'

    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - uses: actions/setup-node@v3
      - uses: actions/setup-python@v4
        with:
          python-version: '3.9'

      - name: Install techdocs-cli
        run: sudo npm install -g @techdocs/cli

      - name: Install mkdocs and mkdocs plugins
        run: python -m pip install mkdocs-techdocs-core==1.*

      - name: Generate docs site
        run: techdocs-cli generate --no-docker --verbose --source-dir ./techdocs/

      - name: Publish docs site
        run: techdocs-cli publish --publisher-type awsS3 --storage-name $TECHDOCS_S3_BUCKET_NAME --entity $ENTITY_NAMESPACE/$ENTITY_KIND/$ENTITY_NAME