fix(ci): validate Windows builds before release tags - #4
Merged
Conversation
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.
PasWeave v0.1.0-alpha.1
PasWeave's first public alpha turns Free Pascal interface declarations and
their documentation comments into a searchable, equation-capable static API
site. It also emits deterministic Markdown and a reusable JSON model.
This is an early release intended for evaluation and feedback. The output is
already useful, but project configuration and parts of the semantic model will
continue to evolve before a stable release.
Download
Download these two files from the release assets:
pasweave.exepasweave.exe.sha256The executable is a portable Windows x86-64 application: there is no installer
or ZIP package, and Free Pascal is not required at runtime. Place it anywhere
and run:
The HTML site is self-contained for offline use. PasWeave extracts its embedded
KaTeX and Mermaid resources into the generated site's asset directory.
Verify the download before running it:
The values must match. This alpha is not code-signed, so Windows may display a
SmartScreen warning.
Highlights
fcl-passrcparserlibraries rather than guessing from declaration text.
static HTML.
structured directives, source positions, and light and dark colour schemes.
inheritance, and interface implementation relationships.
non-interactive text fallback.
with repeatable include and exclude globs.
Documentation comments
The safe default recognizes consecutive
///lines. This is an explicitPasWeave convention: Free Pascal sees them as ordinary line comments, and
ordinary
//comments are not documentation.Pascal block comments can be enabled per project:
Enabled adjacent forms can be mixed in source order. Documentation must
immediately precede an interface declaration; a blank line ends the
association. Compiler directives such as
{$mode objfpc}and(*$...*)arenever documentation.
Structured
@param,@returns,@raises,@deprecated,@see, and@sincedirectives are extracted from documentation groups.
Compatibility
fcl-passrcandfcl-json{$mode objfpc}Validation
The full test suite and an isolated portable-executable smoke test run before
the release workflow publishes any binary.
Against the recorded
mathlib-fprevision, PasWeave parsed all 45 units into2,338 model symbols with no parse errors, missing source positions, or
duplicate stable IDs. It rendered 2,227 API symbols and resolved 97
project-local dependency edges. Because that project contains no PasWeave
///comments, default documentation coverage is correctly 0 of 2,227;enabling brace comments finds 570 documented API symbols, with the documented
section-label false-positive caveat described in the validation report.
The equation-rich scientific showcase documents all 30 public API symbols and
contains 16 display equations and 65 inline mathematical expressions. The
portable smoke test also verifies all 67 extracted third-party assets
byte-for-byte.
See the complete mathlib-fp validation report
and the checked-in scientific API showcase.
Known alpha limitations
declarations originating from include files do not yet receive it.
library or otherwise out-of-scope ancestors unresolved.
review coverage findings when enabling
braceorparenon an existingcodebase.
documented subset.
See the README limitations and
roadmap for the current boundaries and next milestones.
License and attribution
PasWeave is released under the MIT License. Embedded KaTeX and
Mermaid components retain their own license notices in
THIRD_PARTY_NOTICES.md.
Questions, bugs, and real-world compatibility reports are welcome in
GitHub Issues.