diff --git a/.github/workflows/manual-workflow.publish-documentation.yml b/.github/workflows/manual-workflow.publish-developer-guide.yml similarity index 79% rename from .github/workflows/manual-workflow.publish-documentation.yml rename to .github/workflows/manual-workflow.publish-developer-guide.yml index c967ecb6..64077e09 100644 --- a/.github/workflows/manual-workflow.publish-documentation.yml +++ b/.github/workflows/manual-workflow.publish-developer-guide.yml @@ -1,4 +1,4 @@ -name: Documentation Publication +name: Publish Developer Guide on: workflow_dispatch env: NODE_VERSION: 20.14.0 @@ -19,8 +19,8 @@ jobs: key: node_modules-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }} - if: steps.node-modules-cache.outputs.cache-hit != 'true' run: npm ci - publish-documentation: - name: 'Publishing Documentation' + publish-developer-guide: + name: 'Publishing Developer Guide' needs: install runs-on: ubuntu-latest steps: @@ -35,19 +35,19 @@ jobs: 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: package-json + id: microfrontend-platform-package-json with: path: projects/scion/microfrontend-platform/package.json - - name: 'Building Reference Documentation (Developer Guide)' - run: npm run microfrontend-platform:adoc -- -a revnumber=${{ steps.package-json.outputs.version }} -a revnumber-dasherized=${{ steps.package-json.outputs.version-dasherized }} - - name: 'Deploying Reference Documentation (Developer Guide) to Vercel' + - name: 'Building Developer Guide' + run: npm run microfrontend-platform:adoc -- -a revnumber=${{ steps.microfrontend-platform-package-json.outputs.version }} -a revnumber-dasherized=${{ steps.microfrontend-platform-package-json.outputs.version-dasherized }} + - name: 'Publishing Developer Guide to Vercel' uses: SchweizerischeBundesbahnen/scion-toolkit/.github/actions/vercel-deploy@master with: dist-folder: dist/microfrontend-platform-developer-guide vercel-token: ${{ secrets.VERCEL_TOKEN }} org-id: ${{ secrets.VERCEL_ORG_ID }} project-id: ${{ secrets.VERCEL_MICROFRONTEND_PLATFORM_DEVELOPER_GUIDE_PROJECT_ID }} - version: ${{ steps.package-json.outputs.version }} + version: ${{ steps.microfrontend-platform-package-json.outputs.version }} aliases: | microfrontend-platform-developer-guide.scion.vercel.app, microfrontend-platform-developer-guide-v%v.scion.vercel.app diff --git a/.github/workflows/manual-workflow.publish-typedoc.yml b/.github/workflows/manual-workflow.publish-typedoc.yml new file mode 100644 index 00000000..220d7d64 --- /dev/null +++ b/.github/workflows/manual-workflow.publish-typedoc.yml @@ -0,0 +1,53 @@ +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