MkDocs check and Backstage TechDocs publish
ActionsTags
(2)Github Action for Backstage's techdocs plugin from Spotify.
It scans the whole repository for the following files:
mkdocs.yamlcatalog-info.yaml
The action has two commands:
check- runsmkdocs buildin all directories containingmkdocs.yamland checks for any warnings or errors in the outputpublish- runstechdocs publishin all directories containingcatalog-info.yamlandmkdocs.yaml(the catalog file is used to extract kind/namespace/name of entity)
jobs:
techdocs:
name: Check & Publish
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v3
# Runs mkdocs check in all directories containing **/mkdocs.yaml file
- name: Run mkdocs check
uses: TwistoPayments/actions-techdocs@main
with:
command: check
# Runs techdocs generate and techdocs publish commands in all directories containgin
# **/mkdocs.yaml file. Currently only S3 publisher is supported.
- name: Run techdocs publish
uses: TwistoPayments/actions-techdocs@main
with:
command: publish
env:
TECHDOCS_PUBLISHER_TYPE: awsS3
TECHDOCS_S3_BUCKET_NAME: ${{ secrets.TECHDOCS_S3_BUCKET_NAME }}
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
AWS_REGION: ${{ secrets.AWS_REGION }}Alternatively, you can pull image from Docker Hub which will be faster as you won't need to build the image each time, just replace
uses: TwistoPayments/actions-techdocs@main
with:
command: <check/publish>with
uses: docker://twistopayments/actions-techdocs:main
with:
args: <check/publish>
MkDocs check and Backstage TechDocs publish 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.
Tags
(2)MkDocs check and Backstage TechDocs publish 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.