Skip to content

Publish TechDocs

Actions
Generate and publish TechDocs
v0.0.1
LatestPre-release
Verified creator
Star (1)

Verified

GitHub has manually verified the creator of the action as an official partner organization. For more info see About badges in GitHub Marketplace.

Generate and Publish TechDocs to GCS

EXPERIMENTAL: Use at own risk

GitHub Action for Publishing TechDocs

GitHub Release GitHub Marketplace License

Table of Contents

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>

Publish TechDocs is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Generate and publish TechDocs
v0.0.1
LatestPre-release

Verified

GitHub has manually verified the creator of the action as an official partner organization. For more info see About badges in GitHub Marketplace.

Publish TechDocs is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.