Upgrade the build process to leverage containers and generate pdf and…

… html

Signed-off-by: Rafael Sene <[email protected]>

.github/workflows/build.yml

@@ -0,0 +1,77 @@
+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
+      revision_mark: 
+          description: 'Set revision mark as Draft, Release or Stable:'
+          required: true
+          type: string
+          default: 'Draft'
+      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 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
+            ${{ github.workspace }}/*.html
+        retention-days: 30
+
+    # Create Release
+    - name: Create Release
+      uses: softprops/action-gh-release@v1
+      with:
+        files: |
+            ${{ github.workspace }}/*.pdf
+            ${{ github.workspace }}/*.html
+        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.

.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 .*.swp
 *.pdf
+*.html

Makefile

@@ -1,24 +1,74 @@
-HEADER=profiles.adoc
-DOC_PDF=$(HEADER:%.adoc=%.pdf)
-DOC_HTML=$(HEADER:%.adoc=%.html)
+# Makefile for RISC-V Doc Template
+#
+# This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
+# International License. To view a copy of this license, visit
+# http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to
+# Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+#
+# SPDX-License-Identifier: CC-BY-SA-4.0
+#
+# Description:
+# 
+# This Makefile is designed to automate the process of building and packaging 
+# the Doc Template for RISC-V Extensions.
 
-all: $(DOC_PDF)
+DOCKER_RUN := docker run --rm -v ${PWD}:/build -w /build \
+riscvintl/riscv-docs-base-container-image:latest
 
-%.pdf : %.adoc
-	asciidoctor-pdf \
-	-r asciidoctor-diagram \
-	-a toc \
-	-a compress \
-	-a pdf-style=docs-resources/themes/riscv-pdf.yml \
-	-a pdf-fontsdir=docs-resources/fonts \
-	--failure-level=ERROR \
-	-o $@ $<
+HEADER_SOURCE := profiles.adoc
+PDF_RESULT := $(HEADER_SOURCE:%.adoc=%.pdf)
+HTML_RESULT := $(HEADER_SOURCE:%.adoc=%.html)
 
-html: $(DOC_HTML)
-	open $(DOC_HTML)
+ASCIIDOCTOR_PDF := asciidoctor-pdf
+ASCIIDOCTOR_HTML := asciidoctor
 
-$(DOC_HTML): $(HEADER)
-	asciidoctor -o $@ $<
+OPTIONS := --trace \
+           -a compress \
+           -a mathematical-format=svg \
+           -a pdf-fontsdir=docs-resources/fonts \
+           -a pdf-style=docs-resources/themes/riscv-pdf.yml \
+           --failure-level=ERROR
+
+REQUIRES := --require=asciidoctor-diagram \
+            --require=asciidoctor-mathematical
+
+.PHONY: all build clean build-container-pdf build-no-container-pdf build-container-html build-no-container-html
+
+all: build
+
+build: 
+	@echo "Checking if Docker is available..."
+	@if command -v docker >/dev/null 2>&1 ; then \
+		echo "Docker is available, building inside Docker container..."; \
+		$(MAKE) build-container-pdf; \
+		$(MAKE) build-container-html; \
+	else \
+		echo "Docker is not available, building without Docker..."; \
+		$(MAKE) build-no-container-pdf; \
+		$(MAKE) build-no-container-html; \
+	fi
+
+build-container-pdf:
+	@echo "Starting build inside Docker container..."
+	$(DOCKER_RUN) /bin/sh -c "$(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) --out-file=$(PDF_RESULT) $(HEADER_SOURCE)"
+	@echo "Build completed successfully inside Docker container."
+
+build-no-container-pdf:
+	@echo "Starting build..."
+	$(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) --out-file=$(PDF_RESULT) $(HEADER_SOURCE)
+	@echo "Build completed successfully."
+
+build-container-html:
+	@echo "Starting build inside Docker container..."
+	$(DOCKER_RUN) /bin/sh -c "$(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) --out-file=$(HTML_RESULT) $(HEADER_SOURCE)"
+	@echo "Build completed successfully inside Docker container."
+
+build-no-container-html:
+	@echo "Starting build..."
+	$(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) --out-file=$(HTML_RESULT) $(HEADER_SOURCE)
+	@echo "Build completed successfully."
 
 clean:
-	rm -f $(DOC_PDF)
+	@echo "Cleaning up generated files..."
+	rm -f $(PDF_RESULT) $(HTML_RESULT)
+	@echo "Cleanup completed."