Skip to content

Commit

Permalink
build: release ebook when version tag is pushed
Browse files Browse the repository at this point in the history
  • Loading branch information
dwmkerr authored Sep 30, 2020
1 parent 3ef9a54 commit 50e2f2e
Show file tree
Hide file tree
Showing 3 changed files with 110 additions and 15 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/build-on-pull-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# This pipeline builds the PDF ebook on any pull request to master.
name: "Build PDF"
on:
pull_request:
branches:
- master

jobs:
prepare-pdf:
# Focal Fossa. Please don't use 'latest' tags, it's an anti-pattern.
runs-on: ubuntu-20.04
steps:
# Checkout the code.
- name: Checkout
uses: actions/checkout@v2

# Prepare the content files.
- name: Prepare Content
run: ./scripts/prepare-markdown-for-ebook.sh

# Create a PDF from the prepared markdown.
- name: Prepare PDF
uses: docker://pandoc/latex:2.9
with:
args: "-V toc-title:\"Table Of Contents\" --toc --pdf-engine=pdflatex --standalone --output hacker-laws.pdf hacker-laws.md"

# Publish the PDF and intermediate markdown as an artifact.
- name: Publish PDF Artifact
uses: actions/upload-artifact@master
with:
name: hacker-laws.pdf
path: hacker-laws.pdf

- name: Publish Intermiediate Markdown Artifact
uses: actions/upload-artifact@master
with:
name: hacker-laws.md
path: hacker-laws.md
64 changes: 64 additions & 0 deletions .github/workflows/release-on-tag.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# This pipeline builds the PDF ebook on any tag starting with 'v'.
name: "Create Release"
on:
push:
tags:
- 'v*'

jobs:
prepare-pdf:
# Focal Fossa. Please don't use 'latest' tags, it's an anti-pattern.
runs-on: ubuntu-20.04
steps:
# Checkout the code.
- name: Checkout
uses: actions/checkout@v2

# Prepare the content files.
- name: Prepare Content
run: ./scripts/prepare-markdown-for-ebook.sh

# Create a PDF from the prepared markdown.
- name: Prepare PDF
uses: docker://pandoc/latex:2.9
with:
args: "-V toc-title:\"Table Of Contents\" --toc --pdf-engine=pdflatex --standalone --output hacker-laws.pdf hacker-laws.md"

# Publish the PDF artifact.
- name: Publish PDF Artifacts
uses: actions/upload-artifact@master
with:
name: hacker-laws.pdf
path: hacker-laws.pdf

release:
needs: prepare-pdf
runs-on: ubuntu-20.04
steps:
- name: Download artifact
uses: actions/download-artifact@v2
with:
name: hacker-laws.pdf

- name: Create Release
id: create-release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref }}
release_name: ${{ github.ref }}
body: |
Hacker Laws E-Book
draft: false
prerelease: false

- name: Upload Release Asset
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.create-release.outputs.upload_url }}
asset_path: ./hacker-laws.pdf
asset_name: hacker-laws.pdf
asset_content_type: application/pdf
23 changes: 8 additions & 15 deletions assets/ebook.sh → scripts/prepare-markdown-for-ebook.sh
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
#!/usr/bin/env bash
#
# Requirements:
# - pandoc
# - xelatex
# brew install
# brew cask install basictex
# This script prepares a `hacker-laws.md` file which is in a format ready to be
# exported to PDF or other formats for an e-book.

# Create the frontmatter.
cat << EOF > frontmatter.md
Expand All @@ -20,21 +16,18 @@ cat frontmatter.md README.md >> hacker-laws.md

# Remove the title - we have it in the front-matter of the doc, so it will
# automatically be added to the PDF.
sed -i '' '/💻📖.*/d' hacker-laws.md
sed -i'' '/💻📖.*/d' hacker-laws.md

# We can't have emojis in the final content with the PDF generator we're using.
sed -i '' 's/❗/Warning/' hacker-laws.md
sed -i'' 's/❗/Warning/' hacker-laws.md

# Now rip out the translations line.
sed -i '' '/^\[Translations.*/d' hacker-laws.md
sed -i'' '/^\[Translations.*/d' hacker-laws.md

# # Now rip out any table of contents items.
sed -i '' '/\*.*/d' hacker-laws.md
sed -i '' '/ \*.*/d' hacker-laws.md
sed -i'' '/\*.*/d' hacker-laws.md
sed -i'' '/ \*.*/d' hacker-laws.md

# Delete everything from 'Translations' onwards (we don't need the translations
# lists, related projects, etc).
sed -i ' ' '/## Translations/,$d' hacker-laws.md

# Now build the e-book as a PDF.
pandoc -V toc-title:"Table Of Contents" --toc --pdf-engine=pdflatex -s -o hacker-laws.pdf hacker-laws.md
sed -i'' '/## Translations/,$d' hacker-laws.md

0 comments on commit 50e2f2e

Please sign in to comment.