Merge pull request #23 from nuttycom/fix-render-site

Fix render site

Author: nuttycom

.github/workflows/deploy.yml

@@ -0,0 +1,69 @@
+# Inspired by https://nathan-at-least.github.io/auto-deploy-howto.html
+name: Deploy Rendered Site
+
+on:
+  push:
+    branches: [ main ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  render-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4.1.7
+        with:
+          fetch-depth: 0
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      # Each deploy overwrites the contents of `publish` branch from
+      # `main`, but also introduces a merge structure so that the history of
+      # `publish` is tracked:
+      - name: Overwrite publish branch with main branch
+        run: |
+          set -x
+          BASE_BRANCH="$(git rev-parse --abbrev-ref HEAD)"
+          git config --global user.name 'autodeploy'
+          git config --global user.email 'autodeploy'
+          TMP='local-temp-branch'
+          git checkout -b "$TMP" "$BASE_BRANCH" # Same tree state as main branch
+          git merge origin/publish \
+            --commit -m 'Auto-deploy: merging "main" branch'
+          git checkout publish
+          git merge --ff-only "$TMP"
+          git branch -d "$TMP"
+
+      - name: Compile ZIPs and Zcash Protocol Specification
+        uses: ./.github/actions/render
+
+      - name: Commit and Push to "publish" branch
+        uses: EndBug/add-and-commit@v9.1.4
+        with:
+          add: 'rendered'
+          default_author: github_actions
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'rendered'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/render-site.yaml

@@ -30,3 +30,5 @@ MultiMarkdown-6
 
 protocol/aux/
 protocol/protocol.ver
+
+rendered/

.github/workflows/render.yml

@@ -22,8 +22,13 @@ RUN pip install 'docutils==0.21.2' 'rst2html5==2.0.1'
 
 RUN git config --global --add safe.directory /zips
 
-# Use a fork so that we're running pinned code.
-RUN git clone -b develop https://github.com/Electric-Coin-Company/MultiMarkdown-6 && cd MultiMarkdown-6 && make release && cd build && make && make install
+# Use a fork so that we're running pinned code. The Makefile for
+# MultiMarkdown-6 expects the `master` branch to exist for delta computation,
+# so we also add that branch locally, even though it's otherwise unused.
+RUN git clone -b develop https://github.com/Electric-Coin-Company/MultiMarkdown-6 && \
+  cd MultiMarkdown-6 && \
+  git branch master origin/master && \
+  make release && cd build && make && make install
 
 ENV PATH=${PATH}:/root/.local/bin
 

.gitignore

@@ -10,6 +10,8 @@ all-zips: .Makefile.uptodate
 	echo "$(patsubst zips/%,%,$(sort $(wildcard zips/draft-*.rst) $(wildcard zips/draft-*.md)))" >.draftfilelist.new
 	diff .draftfilelist.current .draftfilelist.new || cp -f .draftfilelist.new .draftfilelist.current
 	rm -f .draftfilelist.new
+	mkdir -p rendered
+	cp -r static/* rendered/
 	$(MAKE) README.rst
 	$(MAKE) rendered/index.html $(addprefix rendered/,$(addsuffix .html,$(basename $(patsubst zips/%,%,$(sort $(wildcard zips/*.rst) $(wildcard zips/*.md))))))
 
@@ -31,7 +33,8 @@ all-specs: all-zips
 	$(MAKE) -C protocol all-specs
 
 discard:
-	git checkout -- 'rendered/*.html' 'README.rst' 'rendered/protocol/*.pdf'
+	rm -r rendered
+	git checkout -- 'README.rst'
 
 .Makefile.uptodate: Makefile render.sh
 	$(MAKE) clean

Dockerfile

@@ -31,19 +31,6 @@ protocol-dark: $(PDFDIR)/protocol-dark.pdf
 all-specs: .Makefile.uptodate
 	$(MAKE) nu6 nu6-dark nu5 canopy heartwood blossom sapling
 
-tag-release:
-ifeq ($(shell git tag --points-at HEAD |wc -l),0)
-	echo "Set a tag at HEAD first."
-else
-	$(eval TAG := $(shell git tag --points-at HEAD))
-	git fetch origin
-	git merge-base --is-ancestor origin/main HEAD || (echo "The current branch is dirty and/or not up-to-date with origin's main branch."; false)
-	$(MAKE) clean all
-	git add $(PDFDIR)/*.pdf
-	git commit -m "Regenerate PDFs." $(PDFDIR)/*.pdf
-	git tag "v$(TAG)"
-endif
-
 discard:
 	git checkout -- "$(PDFDIR)/*.pdf"
 
@@ -82,6 +69,7 @@ auxsapling:
 
 sapling:
 	$(MAKE) auxsapling
+	mkdir -p $(PDFDIR)
 	mv -f aux/sapling.pdf $(PDFDIR)
 
 .PHONY: auxblossom blossom
@@ -94,6 +82,7 @@ auxblossom:
 
 blossom:
 	$(MAKE) auxblossom
+	mkdir -p $(PDFDIR)
 	mv -f aux/blossom.pdf $(PDFDIR)
 
 .PHONY: auxheartwood heartwood
@@ -106,6 +95,7 @@ auxheartwood:
 
 heartwood:
 	$(MAKE) auxheartwood
+	mkdir -p $(PDFDIR)
 	mv -f aux/heartwood.pdf $(PDFDIR)
 
 .PHONY: auxcanopy canopy
@@ -118,6 +108,7 @@ auxcanopy:
 
 canopy:
 	$(MAKE) auxcanopy
+	mkdir -p $(PDFDIR)
 	mv -f aux/canopy.pdf $(PDFDIR)
 
 .PHONY: auxnu5 nu5
@@ -130,6 +121,7 @@ auxnu5:
 
 nu5:
 	$(MAKE) auxnu5
+	mkdir -p $(PDFDIR)
 	mv -f aux/nu5.pdf $(PDFDIR)
 
 .PHONY: auxnu6 nu6
@@ -142,6 +134,7 @@ auxnu6:
 
 nu6:
 	$(MAKE) auxnu6
+	mkdir -p $(PDFDIR)
 	mv -f aux/nu6.pdf $(PDFDIR)/protocol.pdf
 
 .PHONY: auxnu6-dark nu6-dark
@@ -154,8 +147,9 @@ auxnu6-dark:
 
 nu6-dark:
 	$(MAKE) auxnu6-dark
+	mkdir -p $(PDFDIR)
 	mv -f aux/nu6-dark.pdf $(PDFDIR)/protocol-dark.pdf
 
 .PHONY: clean
 clean:
-	rm -f aux/* protocol.ver $(PDFDIR)/protocol.pdf $(PDFDIR)/protocol-dark.pdf $(PDFDIR)/nu5.pdf $(PDFDIR)/canopy.pdf $(PDFDIR)/heartwood.pdf $(PDFDIR)/blossom.pdf $(PDFDIR)/sapling.pdf
+	rm -f aux/* protocol.ver $(PDFDIR)/*