-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Resetting build-pdf.yml back to a working state. Signed-off-by: Bill Traynor <[email protected]>
- Loading branch information
Showing
1 changed file
with
67 additions
and
77 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,84 +1,74 @@ | ||
# 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. | ||
--- | ||
name: Create Specification Document | ||
|
||
DOCS := \docs-dev-guide.adoc | ||
# 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 | ||
|
||
DATE ?= $(shell date +%Y-%m-%d) | ||
VERSION ?= v0.0.0 | ||
REVMARK ?= Draft | ||
ifneq ($(SKIP_DOCKER),true) | ||
DOCKER_CMD := docker run --rm -v ${PWD}:/build -w /build \ | ||
riscvintl/riscv-docs-base-container-image:latest \ | ||
/bin/sh -c | ||
DOCKER_QUOTE := " | ||
endif | ||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
SRC_DIR := src | ||
BUILD_DIR := build | ||
steps: | ||
# Step 1: Checkout the repository | ||
- name: Checkout repository | ||
uses: actions/checkout@v4 | ||
with: | ||
submodules: recursive | ||
|
||
DOCS_PDF := $(DOCS:%.adoc=%.pdf) | ||
DOCS_HTML := $(DOCS:%.adoc=%.html) | ||
# Step 2: Pull the latest RISC-V Docs container image | ||
- name: Pull Container | ||
run: docker pull riscvintl/riscv-docs-base-container-image:latest | ||
|
||
XTRA_ADOC_OPTS := | ||
ASCIIDOCTOR_PDF := asciidoctor-pdf | ||
ASCIIDOCTOR_HTML := asciidoctor | ||
OPTIONS := --trace \ | ||
-a compress \ | ||
-a mathematical-format=svg \ | ||
-a pdf-fontsdir=docs-resources/fonts \ | ||
-a pdf-theme=docs-resources/themes/riscv-pdf.yml \ | ||
$(XTRA_ADOC_OPTS) \ | ||
-D build \ | ||
--failure-level=ERROR | ||
REQUIRES := --require=asciidoctor-diagram \ | ||
--require=asciidoctor-mathematical | ||
# Step 3: Build Files | ||
- name: Build Files | ||
run: make | ||
env: | ||
VERSION: v${{ github.event.inputs.version }} | ||
REVMARK: ${{ github.event.inputs.revision_mark }} | ||
|
||
.PHONY: all build clean build-container build-no-container | ||
# Step 4: Upload the built PDF files as a single artifact | ||
- name: Upload Build Artifacts | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: Build Artifacts | ||
path: ${{ github.workspace }}/build/*.pdf | ||
retention-days: 30 | ||
|
||
all: build | ||
|
||
build-docs: $(DOCS_PDF) $(DOCS_HTML) | ||
|
||
vpath %.adoc $(SRC_DIR) | ||
|
||
%.pdf: %.adoc | ||
$(DOCKER_CMD) $(DOCKER_QUOTE) $(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) $< $(DOCKER_QUOTE) | ||
|
||
%.html: %.adoc | ||
$(DOCKER_CMD) $(DOCKER_QUOTE) $(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) $< $(DOCKER_QUOTE) | ||
|
||
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; \ | ||
else \ | ||
echo "Docker is not available, building without Docker..."; \ | ||
$(MAKE) build-no-container; \ | ||
fi | ||
|
||
build-container: | ||
@echo "Starting build inside Docker container..." | ||
$(MAKE) build-docs | ||
@echo "Build completed successfully inside Docker container." | ||
|
||
build-no-container: | ||
@echo "Starting build..." | ||
$(MAKE) SKIP_DOCKER=true build-docs | ||
@echo "Build completed successfully." | ||
|
||
clean: | ||
@echo "Cleaning up generated files..." | ||
rm -rf $(BUILD_DIR) | ||
@echo "Cleanup completed." | ||
# Create Release | ||
- name: Create Release | ||
uses: softprops/action-gh-release@v1 | ||
with: | ||
files: ${{ github.workspace }}/build/*.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. |