forked from riscv/riscv-cheri
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request riscv#12 from rpsene/main
Update the build process to use containers and add minor improvements
- Loading branch information
Showing
5 changed files
with
123 additions
and
129 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,79 +1,42 @@ | ||
# This workflow installs dependencies for PDF generation, generates the PDF, | ||
# and uploads the PDF as an artifact. | ||
|
||
name: Build Document PDF | ||
name: Build RISC-V Doc Spec Template | ||
|
||
on: | ||
workflow_dispatch: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
workflow_dispatch: | ||
workflow_call: | ||
outputs: | ||
name: | ||
description: "The base name of the pdf file (without .pdf extensions)" | ||
value: ${{ jobs.build.outputs.name }} | ||
pdf-name: | ||
description: "The name of the pdf file (with .pdf extensions)" | ||
value: ${{ jobs.build.outputs.pdf-name }} | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-22.04 | ||
|
||
env: | ||
NAME: example-spec | ||
APT_PACKAGES_FILE: ${{ github.workspace }}/dependencies/apt_packages.txt | ||
BUNDLE_GEMFILE: ${{ github.workspace }}/dependencies/Gemfile | ||
BUNDLE_BIN: ${{ github.workspace }}/bin | ||
NPM_PACKAGE_FOLDER: ${{ github.workspace }}/dependencies | ||
outputs: | ||
name: ${{ steps.step1.outputs.name }} | ||
pdf-name: ${{ steps.step2.outputs.pdf-name }} | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Set outputs.name | ||
id: step1 | ||
run: echo "name=$NAME" >> $GITHUB_OUTPUT | ||
- name: Set outputs.pdf-name | ||
id: step2 | ||
run: echo "pdf-name=$NAME.pdf" >> $GITHUB_OUTPUT | ||
# Checkout the repository | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
with: | ||
submodules: 'true' | ||
- name: Install Ubuntu packages | ||
|
||
# Pull the latest RISC-V Docs container image | ||
# https://github.com/riscv/riscv-docs-base-container-image | ||
# https://hub.docker.com/r/riscvintl/riscv-docs-base-container-image | ||
- name: Pull Container | ||
run: | | ||
sudo apt-get update | ||
grep -vE '^#' ${APT_PACKAGES_FILE} | xargs sudo apt-get install --yes --no-install-recommends | ||
# Ruby for asciidoctor | ||
- name: Setup Ruby and Gemfile content | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: "3.2.0" | ||
bundler-cache: true | ||
# Node.js for wavedrom | ||
- uses: actions/cache@v3 | ||
with: | ||
path: ~/.npm | ||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | ||
restore-keys: | | ||
${{ runner.os }}-node- | ||
- name: Setup Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: '16' | ||
- name: Install Node.js dependencies | ||
run: npm install ${NPM_PACKAGE_FOLDER} | ||
- name: Generate PDF | ||
docker pull riscvintl/riscv-docs-base-container-image:latest | ||
# Build PDF file using the container | ||
- name: Build Files | ||
run: | | ||
PATH=${PATH}:${BUNDLE_BIN}:$(npm bin) \ | ||
make | ||
- name: Archive PDF result | ||
docker run --rm -v ${{ github.workspace }}:/build riscvintl/riscv-docs-base-container-image:latest \ | ||
/bin/sh -c 'make' | ||
# Set the short SHA for use in artifact names | ||
- name: Set short SHA | ||
run: echo "SHORT_SHA=$(echo ${GITHUB_SHA::7})" >> $GITHUB_ENV | ||
|
||
# Upload the built PDF file as artifact | ||
- name: Upload Build Artifact | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: ${{ env.NAME }}.pdf | ||
path: ${{ env.NAME }}.pdf | ||
name: spec-sample-${{ env.SHORT_SHA }}.pdf | ||
path: ${{ github.workspace }}/spec-sample.pdf | ||
retention-days: 7 |
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
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,21 +1,39 @@ | ||
# 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. | ||
|
||
HEADER_SOURCE := header.adoc | ||
PDF_RESULT := example-spec.pdf | ||
PDF_RESULT := spec-sample.pdf | ||
|
||
ASCIIDOCTOR_PDF := asciidoctor-pdf | ||
OPTIONS := --trace -a compress \ | ||
--attribute=mathematical-format=svg \ | ||
--attribute=pdf-fontsdir=docs-resources/fonts \ | ||
--attribute=pdf-style=docs-resources/themes/riscv-pdf.yml \ | ||
-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-bibtex \ | ||
--require=asciidoctor-diagram \ | ||
--require=asciidoctor-mathematical | ||
|
||
.PHONY: all build clean | ||
|
||
all: build | ||
|
||
build: | ||
@echo "Building asciidoc" | ||
$(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) --out-file=$(PDF_RESULT) $(HEADER_SOURCE) | ||
|
||
clean: | ||
rm $(PDF_RESULT) | ||
@echo "Cleaning up generated files" | ||
rm -f $(PDF_RESULT) | ||
|
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,3 +1,2 @@ | ||
Dependencies for the build environment for various package managers. Used in | ||
`.github/workflows/`. | ||
|
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