Skip to content

Commit 4ac57c1

Browse files
committed
ci: provide manual deployment of TypeDoc
1 parent 85f7bf1 commit 4ac57c1

File tree

2 files changed

+52
-4
lines changed

2 files changed

+52
-4
lines changed

.github/workflows/manual-workflow.publish-documentation.yml renamed to .github/workflows/manual-workflow.publish-developer-guide.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Documentation Publication
1+
name: Publish Developer Guide
22
on: workflow_dispatch
33
env:
44
NODE_VERSION: 20.14.0
@@ -20,7 +20,7 @@ jobs:
2020
- if: steps.node-modules-cache.outputs.cache-hit != 'true'
2121
run: npm ci
2222
publish-documentation:
23-
name: 'Publishing Documentation'
23+
name: 'Publishing Developer Guide'
2424
needs: install
2525
runs-on: ubuntu-latest
2626
steps:
@@ -38,9 +38,9 @@ jobs:
3838
id: package-json
3939
with:
4040
path: projects/scion/microfrontend-platform/package.json
41-
- name: 'Building Reference Documentation (Developer Guide)'
41+
- name: 'Building Developer Guide'
4242
run: npm run microfrontend-platform:adoc -- -a revnumber=${{ steps.package-json.outputs.version }} -a revnumber-dasherized=${{ steps.package-json.outputs.version-dasherized }}
43-
- name: 'Deploying Reference Documentation (Developer Guide) to Vercel'
43+
- name: 'Publishing Developer Guide to Vercel'
4444
uses: SchweizerischeBundesbahnen/scion-toolkit/.github/actions/vercel-deploy@master
4545
with:
4646
dist-folder: dist/microfrontend-platform-developer-guide
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Publish TypeDoc
2+
on: workflow_dispatch
3+
env:
4+
NODE_VERSION: 20.14.0
5+
jobs:
6+
install:
7+
name: 'Installing NPM modules'
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v4
11+
- uses: actions/setup-node@v4
12+
with:
13+
node-version: ${{ env.NODE_VERSION }}
14+
- name: 'Caching NPM modules if necessary'
15+
uses: actions/cache@v4
16+
id: node-modules-cache
17+
with:
18+
path: ./node_modules
19+
key: node_modules-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
20+
- if: steps.node-modules-cache.outputs.cache-hit != 'true'
21+
run: npm ci
22+
publish-documentation:
23+
name: 'Publishing TypeDoc'
24+
needs: install
25+
runs-on: ubuntu-latest
26+
steps:
27+
- uses: actions/checkout@v4
28+
- uses: actions/setup-node@v4
29+
with:
30+
node-version: ${{ env.NODE_VERSION }}
31+
- name: 'Restoring NPM modules from cache'
32+
uses: actions/cache@v4
33+
with:
34+
path: ./node_modules
35+
key: node_modules-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
36+
- name: 'Building TypeDoc'
37+
run: npm run microfrontend-platform:typedoc
38+
- name: 'Publishing TypeDoc to Vercel'
39+
uses: SchweizerischeBundesbahnen/scion-toolkit/.github/actions/vercel-deploy@master
40+
with:
41+
dist-folder: dist/microfrontend-platform-api
42+
vercel-token: ${{ secrets.VERCEL_TOKEN }}
43+
org-id: ${{ secrets.VERCEL_ORG_ID }}
44+
project-id: ${{ secrets.VERCEL_MICROFRONTEND_PLATFORM_API_PROJECT_ID }}
45+
version: ${{ needs.build-platform.outputs.version }}
46+
aliases: |
47+
microfrontend-platform-api.scion.vercel.app,
48+
microfrontend-platform-api-v%v.scion.vercel.app

0 commit comments

Comments
 (0)