Add non-normative comment to clarify MXR behavior. #5
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: Create Specification Document | |
| # The workflow is triggered by pull request, push to main, and manual dispatch. | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| create_release: | |
| description: 'Create a new RISC-V ISA release if set to true' | |
| required: false | |
| default: 'false' | |
| target_branch: | |
| description: 'Target Branch' | |
| required: true | |
| default: 'main' | |
| release_notes: | |
| description: 'Release Notes' | |
| required: false | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Step 1: Checkout the repository | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| with: | |
| submodules: 'recursive' | |
| # Step 2: Pull the latest RISC-V Docs container image | |
| - name: Pull Container | |
| run: docker pull riscvintl/riscv-docs-base-container-image:latest | |
| # Step 3: Build Files | |
| - name: Build Files | |
| run: make | |
| env: | |
| VERSION: v${{ github.event.inputs.version }} | |
| REVMARK: ${{ github.event.inputs.revision_mark }} | |
| # Step 4: Upload the built PDF files as a single artifact | |
| - name: Upload Build Artifacts | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: Build Artifacts | |
| path: ${{ github.workspace }}/*.pdf | |
| retention-days: 30 | |
| # Create Release | |
| - name: Create Release | |
| uses: softprops/action-gh-release@v1 | |
| with: | |
| files: ${{ github.workspace }}/*.pdf | |
| tag_name: v${{ github.event.inputs.version }} | |
| name: Release ${{ github.event.inputs.version }} | |
| draft: ${{ github.event.inputs.draft }} | |
| prerelease: ${{ github.event.inputs.prerelease }} | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GHTOKEN }} | |
| if: github.event_name == 'workflow_dispatch' | |
| # This condition ensures this step only runs for workflow_dispatch events. |