chore: polish mix.exs and add ExDoc + Pages workflows#129
Merged
Conversation
- mix.exs: add description, source/homepage URLs, elixirc_paths(:test), docs config with module groups, ex_doc dep, preferred_envs via def cli/0 - test/test_helper.exs: drop manual Code.require_file in favor of elixirc_paths(:test) including test/support - lib/eevm.ex: rewrite landing moduledoc — drop stale "learning project" framing, list actual top-level modules - lib/eevm/block/receipt.ex: fix broken doc reference (t:EEVM.Block.Bloom.log_entry/0) - .github/workflows/elixir.yml -> ci.yml: rename and add a Docs job that fails on ExDoc warnings - .github/workflows/pages.yml: new — builds and deploys docs to GitHub Pages on push to main Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The Docs job tripped on `use Bitwise is deprecated` from deps/bn — a transitive hex dep, not our code. Lint already enforces `mix compile --warnings-as-errors` for our own code (deps are excluded by default), so the docs job should only fail on warnings emitted by ExDoc itself (broken `t:.../0` refs, missing modules, etc.), not on compile-time warnings that surface during a fresh dep build. Split compile and docs into separate steps and use awk to grep only the lines after the "Generating docs..." marker. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
1 participant
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.
Summary
mix.exs: add description, source/homepage URLs,@versionconstant,elixirc_paths(:test), fulldocs:config with module groups,ex_docdep (dev-only), and movepreferred_cli_envintodef cli/0(Mix 1.18+).lib/eevm.ex: rewrite the landing moduledoc — drops the stale "learning project / Elixir Concepts Demonstrated" framing and lists the actual top-level modules (Interpreter, Precompiles, Transaction, Block.Processor, MPT, etc.).lib/eevm/block/receipt.ex: fix a broken ExDoc reference (EEVM.Block.Bloom.log_entry/0→t:EEVM.Block.Bloom.log_entry/0).test/test_helper.exs: drop the manualCode.require_filefortest/support/**now thatelixirc_paths(:test)handles it..github/workflows/elixir.yml→ci.yml: rename and add aDocsjob that runsmix docsand fails on warnings..github/workflows/pages.yml(new): builds and deploys docs to GitHub Pages on push tomain(and viaworkflow_dispatch).Test plan
mix compile --warnings-as-errorscleanmix test— 611 tests + 4 doctests, 0 failuresmix docs— generatesdoc/index.htmlwith zero warningsmain(or manualworkflow_dispatch) will publish tohttps://mw2000.github.io/eevm/.🤖 Generated with Claude Code