Merging upstream changes and repository restructuring into zsa1

.github/actions/render/action.yml

@@ -0,0 +1,7 @@
+name: Render ZIPs and Zcash Protocol Specification
+description: GitHub Action to compile ZIPs and Zcash Protocol Specification LaTeX documents
+author: Deirdre Connolly
+runs:
+  using: docker
+  # Runs `make all` or something like it
+  image: ../../../Dockerfile

.github/workflows/deploy.yml

@@ -0,0 +1,42 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy pre-rendered static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  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:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - 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.yml

@@ -1,19 +1,25 @@
-name: Render pdfs
+name: Build tex and rst
 
-on: workflow_dispatch
+on: 
+  workflow_dispatch:
+  push:
+    branches:
+    - main
 
 jobs:
 
   render:
     runs-on: ubuntu-latest
     steps:
-      - name: Set up Git repository
-        uses: actions/checkout@v4.1.1
+      - name: Checkout repository
+        uses: actions/checkout@v4.1.7
+        with: 
+          token: ${{ secrets.CI_TOKEN }}
 
-      - name: Compile Zcash Protocol Specification
-        uses: ./.github/actions/render-protocol-pdf
+      - name: Compile ZIPs and Zcash Protocol Specification
+        uses: ./.github/actions/render
 
-      - uses: EndBug/add-and-commit@v9.1.3
+      - uses: EndBug/add-and-commit@v9.1.4
         with:
-          add: '**/*.pdf'
+          add: 'protocol/*.pdf *.html'
           default_author: github_actions

.gitignore

@@ -22,6 +22,7 @@
 
 .Makefile.uptodate
 .zipfilelist.*
+.draftfilelist.*
 
 protocol/aux/
 protocol/html/

Dockerfile

@@ -1,7 +1,7 @@
 FROM debian:latest
 
-RUN apt-get update \
-        && apt-get install -y \
+RUN apt-get update
+RUN apt-get install -y \
         gawk \
         perl \
         sed \
@@ -17,7 +17,10 @@ RUN apt-get update \
         texlive-plain-generic \
         texlive-bibtex-extra
 
-RUN pip3 install rst2html5
+RUN rm /usr/lib/python3.11/EXTERNALLY-MANAGED
+RUN pip install rst2html5
+
+ENV PATH=${PATH}:/root/.local/bin
 
 WORKDIR "/zips"
 ENTRYPOINT ["make", "all"]

Makefile

@@ -2,11 +2,14 @@
 
 .PHONY: all all-zips tag-release protocol discard
 all-zips: .Makefile.uptodate
-	find . -name 'zip-*.rst' -o -name 'zip-*.md' |sort >.zipfilelist.new
+	echo "$(patsubst zips/%,%,$(sort $(wildcard zips/zip-*.rst) $(wildcard zips/zip-*.md)))" >.zipfilelist.new
 	diff .zipfilelist.current .zipfilelist.new || cp -f .zipfilelist.new .zipfilelist.current
 	rm -f .zipfilelist.new
+	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
 	$(MAKE) README.rst
-	$(MAKE) index.html $(addsuffix .html,$(filter-out README,$(basename $(sort $(wildcard *.rst) $(wildcard *.md)))))
+	$(MAKE) rendered/index.html $(addprefix rendered/,$(addsuffix .html,$(basename $(patsubst zips/%,%,$(sort $(wildcard zips/*.rst) $(wildcard zips/*.md))))))
 
 all: all-zips protocol
 
@@ -17,41 +20,41 @@ protocol:
 	$(MAKE) -C protocol
 
 discard:
-	git checkout -- '*.html' 'README.rst' 'protocol/*.pdf'
+	git checkout -- 'rendered/*.html' 'README.rst' 'rendered/protocol/*.pdf'
 
-.Makefile.uptodate: Makefile
+.Makefile.uptodate: Makefile edithtml.sh
 	$(MAKE) clean
 	touch .Makefile.uptodate
 
 define PROCESSRST
-$(eval TITLE := $(shell echo '$(basename $<)' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||'))
+$(eval TITLE := $(shell echo '$(patsubst zips/%,%,$(basename $<))' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||'))
 rst2html5 -v --title="$(TITLE)" $< >$@
 ./edithtml.sh --rst $@
 endef
 
 define PROCESSMD
-$(eval TITLE := $(shell echo '$(basename $<)' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||'))
+$(eval TITLE := $(shell echo '$(patsubst zips/%,%,$(basename $<))' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||'))
 pandoc --from=markdown --to=html $< --output=$@
 ./edithtml.sh --md $@ "${TITLE}"
 endef
 
-index.html: README.rst edithtml.sh
+rendered/index.html: README.rst edithtml.sh
 	$(PROCESSRST)
 
-%.html: %.rst edithtml.sh
+rendered/%.html: zips/%.rst edithtml.sh
 	$(PROCESSRST)
 
-%.html: %.md edithtml.sh
+rendered/%.html: zips/%.md edithtml.sh
 	$(PROCESSMD)
 
-README.rst: .zipfilelist.current makeindex.sh README.template $(sort $(wildcard zip-*.rst) $(wildcard zip-*.md))
+README.rst: .zipfilelist.current .draftfilelist.current makeindex.sh README.template $(wildcard zips/zip-*.rst) $(wildcard zips/zip-*.md) $(wildcard zips/draft-*.rst) $(wildcard zips/draft-*.md)
 	./makeindex.sh | cat README.template - >README.rst
 
 .PHONY: linkcheck
 linkcheck: all-zips
 	$(MAKE) -C protocol all-specs
-	./links_and_dests.py --check $(filter-out $(wildcard draft-*.html),$(wildcard *.html)) protocol/protocol.pdf protocol/canopy.pdf protocol/heartwood.pdf protocol/blossom.pdf protocol/sapling.pdf
+	./links_and_dests.py --check $(filter-out $(wildcard rendered/draft-*.html),$(wildcard rendered/*.html)) rendered/protocol/protocol.pdf rendered/protocol/canopy.pdf rendered/protocol/heartwood.pdf rendered/protocol/blossom.pdf rendered/protocol/sapling.pdf
 
 .PHONY: clean
 clean:
-	rm -f .zipfilelist.* README.rst index.html $(addsuffix .html,$(basename $(sort $(wildcard *.rst) $(wildcard *.md))))
+	rm -f .zipfilelist.* README.rst rendered/index.html $(addprefix rendered/,$(addsuffix .html,$(basename $(patsubst zips/%,%,$(sort $(wildcard zips/*.rst) $(wildcard zips/*.md))))))