Skip to content

Commit

Permalink
Workflow to publish Backstage TechDocs
Browse files Browse the repository at this point in the history
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
  • Loading branch information
awanlin committed Aug 18, 2023
1 parent 79237f9 commit 8572c9e
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions .github/workflows/techdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: 'Publish Backstage TechDocs'

on:
workflow_dispatch:

# Run Daily at 10:00 UTC time
schedule:
- cron: "0 10 * * *"

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
publish-techdocs-site:
runs-on: ubuntu-latest

steps:
- name: Checkout Backstage
uses: actions/checkout@v3
with:
repository: backstage/backstage
fetch-depth: 1

- name: use node.js 18.x
uses: actions/setup-node@v3
with:
node-version: 18.x
registry-url: https://registry.npmjs.org/ # Needed for auth
- 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

- name: Publish docs site
run: techdocs-cli publish --publisher-type googleGcs --storage-name ${{ secrets.TECHDOCS_GCS_BUCKET }} --entity default/component/backstage

0 comments on commit 8572c9e

Please sign in to comment.