Skip to content

Commit

Permalink
Merge pull request #1 from eMoflon/feature/ci-build-config
Browse files Browse the repository at this point in the history
Initial GitHub Actions CI PDF build
  • Loading branch information
adrianmoeller authored Sep 19, 2023
2 parents 1964104 + a3e53df commit 8c76a50
Show file tree
Hide file tree
Showing 15 changed files with 62 additions and 10 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/pdf.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Build PDF Documentation

on:
push:
branches:
- main
- 'testing/**'
- 'feature/**'
- 'hotfix/**'

permissions:
contents: write

jobs:
build-integrate-pdf:
runs-on: [ubuntu-22.04]
steps:
- name: Check out repository code
uses: actions/checkout@v3
- name: Build PDF
run: |
cd doc/ibex/tgg/integrate-framework
docker run --rm -v $PWD:/data maxkratz/pandoc-builder:latest ./md2pdf.sh
- name: Upload artifact
uses: actions/upload-artifact@v3
with:
name: integrate.pdf
path: doc/ibex/tgg/integrate-framework/integrate-framework.pdf
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

*.pdf
2 changes: 2 additions & 0 deletions doc/ibex/tgg/integrate-framework/00-integrate-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ As well as the following notable helper tools:
Together with the *sequential synchronization framework* and *local consistency check framework*, all these tools are utilized by INTEGRATE to form a synchronization tool kit. Fragments are used to compose a custom synchronization flow. INTEGRATE provides a set of predefined Fragments:

* [Fragment Provider](10-fragment-provider.md)

---
2 changes: 1 addition & 1 deletion doc/ibex/tgg/integrate-framework/02-match-classifier.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Match Classifier

TODO
TODO
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Multiplicity Counter

TODO
TODO
2 changes: 1 addition & 1 deletion doc/ibex/tgg/integrate-framework/04-conflict-detector.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Conflict Detector

TODO
TODO
2 changes: 1 addition & 1 deletion doc/ibex/tgg/integrate-framework/05-conflict-resolver.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Conflict Resolver

TODO
TODO
2 changes: 1 addition & 1 deletion doc/ibex/tgg/integrate-framework/06-revoker.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Revoker

TODO
TODO
2 changes: 1 addition & 1 deletion doc/ibex/tgg/integrate-framework/07-match-util.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Match Util

TODO
TODO
2 changes: 1 addition & 1 deletion doc/ibex/tgg/integrate-framework/08-match-analyzer.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Match Analyzer

TODO
TODO
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Model Change Protocol

TODO
TODO
2 changes: 1 addition & 1 deletion doc/ibex/tgg/integrate-framework/10-fragment-provider.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Fragment Provider

TODO
TODO
2 changes: 1 addition & 1 deletion doc/ibex/tgg/integrate-framework/11-conflicts-example.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Conflicts: A combined example

TODO
TODO
6 changes: 6 additions & 0 deletions doc/ibex/tgg/integrate-framework/hashids.lua
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
function Link (el)
if el.target and string.gmatch(el.target, 'md$') then
el.target = '#' .. el.target
end
return el
end
14 changes: 14 additions & 0 deletions doc/ibex/tgg/integrate-framework/md2pdf.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/bin/bash

set -e

if [ -e 'all.md' ]; then rm all.md; fi

# Concat all mds to one file
for i in *.md;
do echo "<div id=\"$i\"></div>" | cat - $i >>all.md
done

# Compile the file
pandoc -f markdown --lua-filter=hashids.lua -o integrate-framework.pdf all.md
rm all.md

0 comments on commit 8c76a50

Please sign in to comment.