GitHub Pages #23
This file contains hidden or 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
| # ----------------------------------------------------------------------------- | |
| # DO NOT EDIT! | |
| # Automatically generated from npm-packages-helper/templates/*. | |
| # | |
| # This file is part of the xPack project (http://xpack.github.io). | |
| # Copyright (c) 2020 Liviu Ionescu. All rights reserved. | |
| # | |
| # Permission to use, copy, modify, and/or distribute this software | |
| # for any purpose is hereby granted, under the terms of the MIT license. | |
| # | |
| # If a copy of the license was not distributed with this file, it can | |
| # be obtained from https://opensource.org/licenses/mit. | |
| # | |
| # ----------------------------------------------------------------------------- | |
| # Simple workflow for deploying static content to GitHub Pages | |
| name: GitHub Pages | |
| on: | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| inputs: | |
| repository: | |
| description: The GitHub repository with the web content | |
| required: false | |
| default: 'xpack/doxygen2docusaurus-cli-ts' | |
| ref: | |
| description: The branch with the web content | |
| required: false | |
| default: 'master' | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| # Single deploy job since we're just deploying | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{steps.deployment.outputs.page_url}} | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Checkout | |
| # https://github.com/actions/checkout | |
| uses: actions/checkout@v6.0.2 | |
| with: | |
| repository: '${{inputs.repository}}' | |
| ref: '${{inputs.ref}}' | |
| # The full history, required to compute lastUpdatedAt | |
| fetch-depth: 0 | |
| - name: Use Nodejs | |
| # https://github.com/actions/setup-node | |
| uses: actions/setup-node@v6.4.0 | |
| with: | |
| node-version: 24 | |
| - name: Install dependencies | |
| run: (npm ci; cd website; npm ci) | |
| - name: Build the Docusaurus site | |
| env: | |
| DOCUSAURUS_BASEURL: '/doxygen2docusaurus/' | |
| run: (cd website; npm run generate-website-tsdoc && npm run build) | |
| - name: Setup Pages | |
| # https://github.com/actions/configure-pages | |
| uses: actions/configure-pages@v6.0.0 | |
| - name: Upload artifact | |
| # https://github.com/actions/upload-pages-artifact | |
| uses: actions/upload-pages-artifact@v5.0.0 | |
| with: | |
| # Upload entire repository | |
| path: './website/build' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| # https://github.com/actions/deploy-pages | |
| uses: actions/deploy-pages@v5.0.0 |