Create mdbook.yml #1
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
| # Sample workflow for building and deploying a mdBook site to GitHub Pages | ||
| # | ||
| # To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html | ||
| # | ||
| name: Deploy mdBook site to Pages | ||
| on: | ||
| # Runs on pushes targeting the default branch | ||
| push: | ||
| branches: ["main"] | ||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
| jobs: | ||
| # Build job | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| MDBOOK_VERSION: 0.4.36 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Install mdBook | ||
| run: | | ||
| curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh | ||
| rustup update | ||
| cargo install --version ${MDBOOK_VERSION} mdbook | ||
| - name: Setup Pages | ||
| id: pages | ||
| uses: actions/configure-pages@v5 | ||
| - name: Build with mdBook | ||
| run: mdbook build | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: ./book | ||
| # Deployment job | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| - name: Cache | ||
| uses: actions/cache@v5.0.4 | ||
| with: | ||
| # A list of files, directories, and wildcard patterns to cache and restore | ||
| path: | ||
| # An explicit key for restoring and saving the cache | ||
| key: | ||
| # An ordered multiline string listing the prefix-matched keys, that are used for restoring stale cache if no cache hit occurred for key. Note `cache-hit` returns false in this case. | ||
| restore-keys: # optional | ||
| # The chunk size used to split up large files during upload, in bytes | ||
| upload-chunk-size: # optional | ||
| # An optional boolean when enabled, allows windows runners to save or restore caches that can be restored or saved respectively on other platforms | ||
| enableCrossOsArchive: # optional, default is false | ||
| # Fail the workflow if cache entry is not found | ||
| fail-on-cache-miss: # optional, default is false | ||
| # Check if a cache entry exists for the given input(s) (key, restore-keys) without downloading the cache | ||
| lookup-only: # optional, default is false | ||
| # Run the post step to save the cache even if another step before fails | ||
| save-always: # optional, default is false | ||
| needs: build | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v5 | ||
| - name: Setup Java JDK | ||
| uses: actions/setup-java@v5.2.0 | ||
| with: | ||
| # The Java version to set up. Takes a whole or semver Java version. See examples of supported syntax in README file | ||
| java-version: # optional | ||
| # The path to the `.java-version` file. See examples of supported syntax in README file | ||
| java-version-file: # optional | ||
| # Java distribution. See the list of supported distributions in README file | ||
| distribution: | ||
| # The package type (jdk, jre, jdk+fx, jre+fx) | ||
| java-package: # optional, default is jdk | ||
| # The architecture of the package (defaults to the action runner's architecture) | ||
| architecture: # optional | ||
| # Path to where the compressed JDK is located | ||
| jdkFile: # optional | ||
| # Set this option if you want the action to check for the latest available version that satisfies the version spec | ||
| check-latest: # optional | ||
| # ID of the distributionManagement repository in the pom.xml file. Default is `github` | ||
| server-id: # optional, default is github | ||
| # Environment variable name for the username for authentication to the Apache Maven repository. Default is $GITHUB_ACTOR | ||
| server-username: # optional, default is GITHUB_ACTOR | ||
| # Environment variable name for password or token for authentication to the Apache Maven repository. Default is $GITHUB_TOKEN | ||
| server-password: # optional, default is GITHUB_TOKEN | ||
| # Path to where the settings.xml file will be written. Default is ~/.m2. | ||
| settings-path: # optional | ||
| # Overwrite the settings.xml file if it exists. Default is "true". | ||
| overwrite-settings: # optional, default is true | ||
| # GPG private key to import. Default is empty string. | ||
| gpg-private-key: # optional | ||
| # Environment variable name for the GPG private key passphrase. Default is $GPG_PASSPHRASE. | ||
| gpg-passphrase: # optional | ||
| # Name of the build platform to cache dependencies. It can be "maven", "gradle" or "sbt". | ||
| cache: # optional | ||
| # The path to a dependency file: pom.xml, build.gradle, build.sbt, etc. This option can be used with the `cache` option. If this option is omitted, the action searches for the dependency file in the entire repository. This option supports wildcards and a list of file names for caching multiple dependencies. | ||
| cache-dependency-path: # optional | ||
| # Workaround to pass job status to post job step. This variable is not intended for manual setting | ||
| job-status: # optional, default is ${{ job.status }} | ||
| # The token used to authenticate when fetching version manifests hosted on github.com, such as for the Microsoft Build of OpenJDK. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | ||
| token: # optional, default is ${{ github.server_url == 'https://github.com' && github.token || '' }} | ||
| # Name of Maven Toolchain ID if the default name of "${distribution}_${java-version}" is not wanted. See examples of supported syntax in Advanced Usage file | ||
| mvn-toolchain-id: # optional | ||
| # Name of Maven Toolchain Vendor if the default name of "${distribution}" is not wanted. See examples of supported syntax in Advanced Usage file | ||
| mvn-toolchain-vendor: # optional | ||
| - name: Setup Go environment | ||
| uses: actions/setup-go@v6.4.0 | ||
| with: | ||
| # The Go version to download (if necessary) and use. Supports semver spec and ranges. Be sure to enclose this option in single quotation marks. | ||
| go-version: # optional | ||
| # Path to the go.mod, go.work, .go-version, or .tool-versions file. | ||
| go-version-file: # optional | ||
| # Set this option to true if you want the action to always check for the latest available version that satisfies the version spec | ||
| check-latest: # optional | ||
| # Used to pull Go distributions from go-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | ||
| token: # optional, default is ${{ github.server_url == 'https://github.com' && github.token || '' }} | ||
| # Used to specify whether caching is needed. Set to true, if you'd like to enable caching. | ||
| cache: # optional, default is true | ||
| # Used to specify the path to a dependency file (e.g., go.mod, go.sum) | ||
| cache-dependency-path: # optional | ||
| # Target architecture for Go to use. Examples: x86, x64. Will use system architecture by default. | ||
| architecture: # optional | ||
| # Custom base URL for downloading Go distributions. Use this to download Go from a mirror or custom source. Defaults to "https://go.dev/dl". Can also be set via the GO_DOWNLOAD_BASE_URL environment variable. The input takes precedence over the environment variable. | ||
| go-download-base-url: # optional | ||
| - name: Setup .NET Core SDK | ||
| uses: actions/setup-dotnet@v5.2.0 | ||
| with: | ||
| # Optional SDK version(s) to use. If not provided, will install global.json version when available. Examples: 2.2.104, 3.1, 3.1.x, 3.x, 6.0.2xx | ||
| dotnet-version: # optional | ||
| # Optional quality of the build. The possible values are: daily, signed, validated, preview, ga. | ||
| dotnet-quality: # optional | ||
| # Optional global.json location, if your global.json isn't located in the root of the repo. | ||
| global-json-file: # optional | ||
| # Optional package source for which to set up authentication. Will consult any existing NuGet.config in the root of the repo and provide a temporary NuGet.config using the NUGET_AUTH_TOKEN environment variable as a ClearTextPassword | ||
| source-url: # optional | ||
| # Optional OWNER for using packages from GitHub Package Registry organizations/users other than the current repository's owner. Only used if a GPR URL is also provided in source-url | ||
| owner: # optional | ||
| # Optional NuGet.config location, if your NuGet.config isn't located in the root of the repo. | ||
| config-file: # optional | ||
| # Optional input to enable caching of the NuGet global-packages folder | ||
| cache: # optional | ||
| # Used to specify the path to a dependency file: packages.lock.json. Supports wildcards or a list of file names for caching multiple dependencies. | ||
| cache-dependency-path: # optional | ||
| # Optional SDK workloads to install for additional platform support. Examples: wasm-tools, maui, aspire. | ||
| workloads: # optional | ||
| # Optional architecture for the .NET install. Supported values: x64, x86, arm64, amd64, arm, s390x, ppc64le, riscv64. If not set, the installer auto-detects the current system architecture. | ||
| architecture: # optional | ||
| - name: First interaction | ||
| uses: actions/first-interaction@v1.3.0 | ||
| with: | ||
| # Token for the repository. Can be passed in using {{ secrets.GITHUB_TOKEN }} | ||
| repo-token: | ||
| # Comment to post on an individual's first issue | ||
| issue-message: # optional | ||
| # Comment to post on an individual's first pull request | ||
| pr-message: # optional | ||
