Closed
Conversation
It's inconvenient to have to manually delete big sections of the guide when starting a new ZIP. This template is intended to be a minimal skeleton that's easy to copy/paste for experienced ZIP authors.
Co-authored-by: Daira-Emma Hopwood <daira@jacaranda.org>
Bumps [actions/checkout](https://github.com/actions/checkout) from 5.0.1 to 6.0.2. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v5.0.1...v6.0.2) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: 6.0.2 dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Daira-Emma Hopwood <daira@jacaranda.org>
Co-authored-by: Daira-Emma Hopwood <daira@jacaranda.org>
Co-authored-by: Daira-Emma Hopwood <daira@jacaranda.org>
Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
…rmaid-11.12.2 Update to katex 0.16.28 and mermaid 11.12.2
Add a ZIP template.
…tions/checkout-6.0.2 Bump actions/checkout from 5.0.1 to 6.0.2
[ZIP 230] Updating the description for the flagsOrchard field
… in their individual capacities as ecosystem participants.
Electric Coin Company. Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
[ZIP 0] Update to indicate that former ECC ZIP editors are now acting in their individual capacities as ecosystem participants.
[ZIP-234] Update Motivations
[ZIP 226, ZIP 230] Limiting the valueBurn to u63
[ZIP 307] spelling corrections
Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
…rmaid-11.12.3 Update to katex 0.16.33 and mermaid 11.12.3
[zip-template] Adjust the title and regenerate README.rst
Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
Pin multimarkdown to the zcash fork (commit 543434c9) instead of the nixpkgs package, ensuring the same version used by the Docker-based build. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace Docker-based GitHub Actions with composite actions that use cachix/install-nix-action and `nix develop` to run builds. This eliminates Docker flakiness in CI and uses the same reproducible Nix environment defined in flake.nix. Changes: - Convert render and render-protocol actions from Docker to composite - Remove safe.directory workarounds (only needed for Docker UID mismatch) - Use `make all` directly instead of `make all-docker` Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Use DeterminateSystems/magic-nix-cache-action to cache the Nix store across CI runs via GitHub Actions cache, avoiding repeated downloads of texlive and other large dependencies. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Use nix for rendering in CI
Co-authored-by: Jack Grigg <thestr4d@gmail.com> Co-authored-by: Kris Nuttycombe <kris@nutty.land>
[ZIP 231] Update abstract and motivation to clarify memo bundle data savings.
Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
update ZIP-0234-block_subsidy.png
ZIP 32: clarify the entropy requirement for wallet seeds
…in rst2html5 The Nix flake was providing docutils' built-in rst2html5 (the html5_polyglot writer), but render.sh expects the separate PyPI package rst2html5 2.0.1 by André Felipe Dias, which has different math handling. This mismatch (introduced by the switch to Nix-based CI rendering) caused warnings for math commands like \underline and \mathbin, and for syntax highlighting of code blocks. This adds a custom derivation for rst2html5 2.0.1 from PyPI with its dependencies (docutils, Genshi, Pygments), matching the versions specified in zip-guide.rst. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Prevents the docutils version from drifting when nixpkgs updates. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The render workflow had two separate jobs that each independently set up Nix and magic-nix-cache, doubling store fetches. FlakeHub Cache also couldn't authenticate due to missing OIDC permissions, causing fallback to GitHub Actions cache which quickly hit rate limits (thousands of "substituter disabled" errors per run). - Add id-token: write permission so FlakeHub Cache can authenticate - Merge render and render-protocol into a single job so Nix is set up once; make all-zips runs first as a fast gate, then make all adds the protocol spec build on top Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This separation previously made sense before the render workflow was simplified to ease caching issues. Now it no longer serves a purpose.
magic-nix-cache required a paid FlakeHub Cache subscription and fell back to GitHub Actions cache with aggressive rate limiting (thousands of "substituter disabled" errors per run). Replace it with actions/cache using nix-store --export/--import to persist the dev shell closure between runs. On cache hit, all store paths are imported locally so nix develop skips network fetches. On cache miss, the build fetches from cache.nixos.org and exports the closure for next time. Also drops the id-token: write permission from render.yml since FlakeHub authentication is no longer needed. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Fix rendering warnings for RST-based ZIPs
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Let's review this here and then we can make the upstream PR.