-
Notifications
You must be signed in to change notification settings - Fork 0
40 lines (35 loc) · 1.14 KB
/
techdocs.yml
File metadata and controls
40 lines (35 loc) · 1.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
name: Generate documentation for Backstage
on:
push:
branches:
- main
paths:
- ".github/workflows/techdocs.yml"
- "docs/**"
- "mkdocs.yml"
jobs:
publish-techdocs-site:
runs-on: ubuntu-latest
env:
ENTITY_NAMESPACE: "default"
ENTITY_KIND: "component"
ENTITY_NAME: "dragons-api"
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: "18"
- name: Install TechDocs CLI
run: npm install -g @techdocs/cli
- name: Install MkDocs TechDocs Core
run: pip install mkdocs-techdocs-core
- name: Generate documentation
run: techdocs-cli generate --no-docker --verbose
- name: Publish documentation on Azure Blob Storage
run: |
techdocs-cli publish \
--entity $ENTITY_NAMESPACE/$ENTITY_KIND/$ENTITY_NAME \
--publisher-type azureBlobStorage \
--azureAccountName ${{ secrets.AZURE_STORAGE_ACCOUNT_NAME }} \
--azureAccountKey ${{ secrets.AZURE_STORAGE_ACCOUNT_KEY }} \
--storage-name ${{ secrets.AZURE_STORAGE_CONTAINER_NAME }}