GitHub Action
Publish TechDocs
v0.0.1
Pre-release
Publish TechDocs
Publish TechDocs
Generate and publish TechDocs
Installation
Copy and paste the following snippet into your .yml file.
- name: Publish TechDocs
uses: gocardless/publish-techdocs-action@v0.0.1
Generate and Publish TechDocs to GCS
EXPERIMENTAL: Use at own risk
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>