gocardless / publish-techdocs-action

Action to generate and publish TechDocs

Generate and Publish TechDocs to GCS

EXPERIMENTAL: Use at own risk

GitHub Action for Publishing TechDocs

Table of Contents

• Usage
  • Workflow

Usage

Workflow

name: publish-techdocs
on:
  push:
    branches:
      - master
    paths:
      - docs/**
jobs:
  publish-techdocs:
    name: Publish Techdocs
    runs-on: ubuntu-latest
    strategy:
      matrix:
        n:
          - env: staging
            secret: TECHDOCS_GCS_SECRET_ACCESS_KEY_STAGING
          - env: production
            secret: TECHDOCS_GCS_SECRET_ACCESS_KEY_PRODUCTION
    steps:
      - uses: actions/checkout@v3
      - name: Publish TechDocs - ${{ matrix.n.env }}
        uses: gocardless/publish-techdocs-action@master
        with:
          publisher: googleGcs
          credentials: ${{ secrets[matrix.n.secret] }}
          bucket: gc-prd-tech-docs-${{ matrix.n.env }}
          entity: default/component/<YOUR_SERVICE_NAME_GOES_HERE>