Publish TypeDoc #1
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 TypeDoc | |
| on: workflow_dispatch | |
| env: | |
| NODE_VERSION: 20.14.0 | |
| jobs: | |
| install: | |
| name: 'Installing NPM modules' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - name: 'Caching NPM modules if necessary' | |
| uses: actions/cache@v4 | |
| id: node-modules-cache | |
| with: | |
| path: ./node_modules | |
| key: node_modules-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }} | |
| - if: steps.node-modules-cache.outputs.cache-hit != 'true' | |
| run: npm ci | |
| publish-typedoc: | |
| name: 'Publishing TypeDoc' | |
| needs: install | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - name: 'Restoring NPM modules from cache' | |
| uses: actions/cache@v4 | |
| with: | |
| path: ./node_modules | |
| key: node_modules-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }} | |
| - name: 'Reading package.json version of scion/microfrontend-platform' | |
| uses: SchweizerischeBundesbahnen/scion-toolkit/.github/actions/package-json@master | |
| id: microfrontend-platform-package-json | |
| with: | |
| path: projects/scion/microfrontend-platform/package.json | |
| - name: 'Building TypeDoc' | |
| run: npm run microfrontend-platform:typedoc | |
| - name: 'Publishing TypeDoc to Vercel' | |
| uses: SchweizerischeBundesbahnen/scion-toolkit/.github/actions/vercel-deploy@master | |
| with: | |
| dist-folder: dist/microfrontend-platform-api | |
| vercel-token: ${{ secrets.VERCEL_TOKEN }} | |
| org-id: ${{ secrets.VERCEL_ORG_ID }} | |
| project-id: ${{ secrets.VERCEL_MICROFRONTEND_PLATFORM_API_PROJECT_ID }} | |
| version: ${{ steps.microfrontend-platform-package-json.outputs.version }} | |
| aliases: | | |
| microfrontend-platform-api.scion.vercel.app, | |
| microfrontend-platform-api-v%v.scion.vercel.app |