Skip to content

Commit

Permalink
feat(publish-techdocs): add github-admonitions plugin (#656)
Browse files Browse the repository at this point in the history
  • Loading branch information
zerok authored Dec 17, 2024
1 parent 1be81b5 commit 7973f46
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion .github/workflows/publish-techdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,20 @@ jobs:

# Pinning until resolved https://github.com/backstage/backstage/issues/25303
- name: Install mkdocs and mkdocs plugins
run: python -m pip install mkdocs-techdocs-core==1.3.5
run: python -m pip install mkdocs-techdocs-core==1.3.5 mkdocs-github-admonitions-plugin==0.0.3

- name: Generate docs site
run: techdocs-cli generate --no-docker --verbose
working-directory: ${{ inputs.default-working-directory }}

# Create an artifact out of the generated documentation so that it can be
# debugged if necessary:
- name: Create docs artifact
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
with:
name: site
path: site

- name: Publish docs site
if: inputs.publish
run: techdocs-cli publish --publisher-type awsS3 --storage-name ${{ steps.instance-settings.outputs.aws-bucket }} --entity ${{ inputs.namespace }}/${{ inputs.kind }}/${{ inputs.name }}
Expand Down

0 comments on commit 7973f46

Please sign in to comment.