Skip to content

Create Specification Document #66

Create Specification Document

Create Specification Document #66

name: Create Specification Document
# The workflow is triggered by pull request, push to main, and manual dispatch.
on:
workflow_dispatch:
inputs:
version:
description: 'Release version, e.g. X.Y.Z:'
required: true
type: string
prerelease:
description: 'Tag as a pre-release?'
required: false
type: boolean
default: true
draft:
description: 'Create release as a draft?'
required: false
type: boolean
default: 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 Vector Spec PDFs
- name: Build Crypto Vector Files
run: cd ./doc/vector && make
env:
VERSION: v${{ github.event.inputs.version }}
REVMARK: ${{ github.event.inputs.revision_mark }}
# Step 4: Upload the built vector PDF file
- name: Upload Crypto Vector Build Artifact
uses: actions/upload-artifact@v3
with:
name: Build Artifacts
path: ${{ github.workspace }}/doc/vector/*.pdf
retention-days: 30
# Create Release
- name: Create Crypto Vector Release
uses: softprops/action-gh-release@v1
with:
files: ${{ github.workspace }}/doc/vector/*.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.