chore(release): refresh README and CHANGELOG for 1.0.0-rc.1#201
Merged
Conversation
Update README to reflect the new Elixir-native VM (no Luerl runtime dependency). Rewrite the Features, encoding/decoding table, and Credits sections. Add a comprehensive 0.5.0 CHANGELOG entry covering the VM rewrite, performance wins, suite progress, behavioural differences from 0.4, and the bug fixes shipped under Direction A. Plan: A12 Closes #173
The VM rewrite (Luerl \u2192 Elixir-native) is significant enough to warrant a major version bump rather than a minor. Cutting an rc first leaves room to catch regressions before locking 1.0 final. - Bump mix.exs @Version to 1.0.0-rc.1. - Rename CHANGELOG entry from [v0.5.0] to [v1.0.0-rc.1] with a brief release-candidate note up top. - Update README Credits to reference 1.0.0. - Update ROADMAP milestone names (0.5.0 \u2192 1.0.0, 0.5.x \u2192 1.0.x) and refresh the stale suite count (4/24 \u2192 5/29) and unit test count (1369 \u2192 1420).
Update A12 title/goal/success criteria, and update A13 to reflect that A12 already bumps mix.exs and seeds the CHANGELOG entry.
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
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.
Update README and CHANGELOG for 1.0.0-rc.1
Plan:
.agents/plans/A12-readme-changelog.mdCloses #173
The VM rewrite (Luerl → Elixir-native) is significant enough to warrant a major version bump rather than a minor. This PR retargets from
0.5.0to1.0.0-rc.1— pre-release leaves room to catch regressions before locking 1.0 final while still signaling the magnitude of the change.Goal
Refresh user-facing docs to reflect the new VM and bump the version to
1.0.0-rc.1.Success criteria
README.mdaccurately describes the new VM (no Luerl claims in Features/encoding tables; only a historical mention in Credits).CHANGELOG.mdhas a1.0.0-rc.1section summarizing:mix.exs@versionbumped to1.0.0-rc.1.lib/lua.exstill pass (52 doctests, 0 failures).mix docsdoes not introduce new warnings (the 6 warnings present are pre-existing on main and reference hidden modules — out of scope; noted in Discoveries).Changes
README revisions:
:luerl.tref()/:luerl.usdref()/:luerl.erl_func()with the new VM's tags ({:tref, integer()},{:udref, integer()},{:native_func, fun}). Removed the MFA row since the new VM doesn't accept that form.CHANGELOG
1.0.0-rc.1entry covers Added / Changed / Removed / Performance / Fixed buckets, with PR references for all major fixes shipped under Direction A.ROADMAP and plan A13 retargeted to
1.0.0milestone naming. ROADMAP's stale 4/24 suite count corrected to 5/29.Discoveries
0.5.0undersold the magnitude of the VM rewrite. After discussion the version was bumped to1.0.0-rc.1.mix docsemits 6 pre-existing warnings onmain(references to hidden modulesLua.CompilerException,Lua.Compiler.Scope.State). These are about code visibility, not docs content — out of scope for a README/CHANGELOG plan. This PR does not introduce new warnings.bitwise.luawas added as ready in fix(vm): handle Lua 5.3 hex and string coercion for bitwise ops #198/feat(stdlib): implement math.fmod for bitwise.lua bit32 verification #199). ROADMAP updated.{module(), atom(), list()}MFA encoding form is no longer accepted byLua.encode!/2in the new VM. Documented in the CHANGELOG's Removed section.Verification
Out of scope (intentional)
Cut 1.0.0-rc.1).mix docswarnings about hidden modules.