Publish Backstage TechDocs #135
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | |
| permissions: | |
| contents: 'read' | |
| id-token: 'write' | |
| steps: | |
| - name: Checkout Backstage | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 | |
| with: | |
| repository: backstage/backstage | |
| fetch-depth: 1 | |
| - name: Setup Node 20.x | |
| uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4 | |
| with: | |
| node-version: 20.x | |
| registry-url: https://registry.npmjs.org/ # Needed for auth | |
| - name: Setup Python 3.9 | |
| uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5 | |
| 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: Clean Up Readmes | |
| run: | | |
| for i in README*.md; do | |
| sed -i 's|docs/assets|assets|g' $i | |
| sed -i 's|README.md|index.md|g' $i | |
| done | |
| - name: Copy Translated Readmes | |
| run: | | |
| mv README-*.md docs | |
| - name: Generate TechDocs | |
| run: techdocs-cli generate --no-docker --legacyCopyReadmeMdToIndexMd --verbose | |
| - name: Login to Google Cloud Services | |
| uses: 'google-github-actions/auth@55bd3a7c6e2ae7cf1877fd1ccb9d54c0503c457c' # v2 | |
| with: | |
| credentials_json: ${{ secrets.TECHDOCS_GCS_CREDENTIALS_JSON }} | |
| - name: Publish TechDocs | |
| run: techdocs-cli publish --publisher-type googleGcs --storage-name ${{ secrets.TECHDOCS_GCS_BUCKET }} --entity default/component/backstage |