Modernize GitHub CI #734
Workflow file for this run
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
| # Copyright 2021-2024 The Khronos Group, Inc. | |
| # SPDX-License-Identifier: Apache-2.0 | |
| # CI to build asciidoctor spec targets, on push or manually | |
| name: CI | |
| # Controls when the action will run. | |
| on: | |
| # Triggers the workflow on push or manual dispatch | |
| push: | |
| branches: | |
| tags: | |
| # Also build when some pull requests are created | |
| pull_request: | |
| # Allows you to run this workflow manually from the Actions tab by | |
| # selecting CI and then "Run workflow" menu on the right branch | |
| # and clicking on "launch_tmate_terminal_for_debug". | |
| # Unfortunately this works only for the default branch. | |
| # So you can either | |
| # - change as the default one default the branch of the PR on the | |
| # GitHub repository owning the PR and launching in Actions tab; | |
| # - or edit directly the step below which runs tmate and push to the | |
| # PR, ignoring the manual workflow launch. | |
| workflow_dispatch: | |
| inputs: | |
| launch_tmate_terminal_for_debug: | |
| type: boolean | |
| description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)' | |
| required: false | |
| default: false | |
| jobs: | |
| build: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| # Use Khronos container with asciidoctor toolchain preinstalled | |
| container: khronosgroup/docker-images:asciidoctor-spec | |
| steps: | |
| - name: Display environment variables | |
| run: env | |
| - name: User and group ids | |
| run: id -a | |
| - name: Execution context information | |
| # Display a lot of information to help further development | |
| # https://docs.github.com/en/actions/learn-github-actions/variables | |
| # https://docs.github.com/en/enterprise-cloud@latest/actions/learn-github-actions/contexts | |
| # The problem is that echo-ing directly "${{ toJSON(github) }}" | |
| # in the shell is not escaped and for example '&' breaks | |
| # things or can lead to server-side script injection. :-( | |
| # So, use environment setting and display the environment | |
| # variable in the shell between "" to avoid unsafe | |
| # interpretation. | |
| env: | |
| execution_context_var_github: ${{ toJSON(github) }} | |
| execution_context_var_env: ${{ toJSON(env) }} | |
| execution_context_var_vars: ${{ toJSON(vars) }} | |
| execution_context_var_job: ${{ toJSON(job) }} | |
| execution_context_var_steps: ${{ toJSON(steps) }} | |
| execution_context_var_runner: ${{ toJSON(runner) }} | |
| execution_context_var_strategy: ${{ toJSON(strategy) }} | |
| execution_context_var_matrix: ${{ toJSON(matrix) }} | |
| execution_context_var_needs: ${{ toJSON(needs) }} | |
| execution_context_var_inputs: ${{ toJSON(inputs) }} | |
| run: | | |
| echo "::group::github context" | |
| echo "$execution_context_var_github" | |
| echo "::endgroup::" | |
| echo "::group::env context" | |
| echo "$execution_context_var_env" | |
| echo "::endgroup::" | |
| echo "::group::vars context" | |
| echo "$execution_context_var_vars" | |
| echo "::endgroup::" | |
| echo "::group::job context" | |
| echo "$execution_context_var_job" | |
| echo "::endgroup::" | |
| echo "::group::steps context" | |
| echo "$execution_context_var_steps" | |
| echo "::endgroup::" | |
| echo "::group::runner context" | |
| echo "$execution_context_var_runner" | |
| echo "::endgroup::" | |
| echo "::group::strategy context" | |
| echo "$execution_context_var_strategy" | |
| echo "::endgroup::" | |
| echo "::group::matrix context" | |
| echo "$execution_context_var_matrix" | |
| echo "::endgroup::" | |
| echo "::group::needs context" | |
| echo "$execution_context_var_needs" | |
| echo "::endgroup::" | |
| echo "::group::inputs context" | |
| echo "$execution_context_var_inputs" | |
| echo "::endgroup::" | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - uses: actions/checkout@v4 | |
| # Unfortunately, asciidoctor-pdf gets pathname-specific errors | |
| # building under the usual $GITHUB_WORKSPACE (/__w). As a workaround, | |
| # generate the outputs in /tmp. | |
| - name: Build spec targets | |
| run: | | |
| cd adoc | |
| make OUTDIR=/tmp/out QUIET= html pdf | |
| # Launch an ssh session via a proxy server if there is a need | |
| # for debug. This seems to live for 35 min max | |
| # https://github.com/mxschmitt/action-tmate | |
| - name: Setup tmate session | |
| uses: mxschmitt/action-tmate@v3 | |
| # To run this, launch it manually on the default branch and | |
| # click on "launch_tmate_terminal_for_debug" | |
| if: github.event_name == 'workflow_dispatch' | |
| && inputs.launch_tmate_terminal_for_debug | |
| - name: Verify reflow conformance | |
| run: | | |
| ./adoc/scripts/verify_reflow_conformance.sh | |
| - name: Archive generated files | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: spec-outputs | |
| path: | | |
| /tmp/out |