Add versioned documentation artifacts to releases - #65
Merged
Conversation
Generate version-bound source docs, offline HTML docs, and samples bundles. Add release metadata and validate archive contents. Attach documentation bundles to GitHub Releases. Keep release artifacts tied to the exact tag and commit. Support local dry-runs and document the maintainer workflow.
github-project-automation
Bot
moved this from Backlog
to Done
in ModernFormsNext Roadmap
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
ModernFormsNext releases will publish versioned documentation and sample bundles generated from the exact release tag and commit. Users of a specific NuGet version can therefore keep matching documentation instead of relying on the evolving content on
master.Artifacts
ModernFormsNext-<version>-docs.zip: README, CHANGELOG, release notes, documentation sources, Release XML docs, public API snapshots, and metadata.ModernFormsNext-<version>-docs-html.zip: self-contained offline DocFX HTML, API reference, local assets, release notes, and metadata.ModernFormsNext-<version>-samples.zip: selected NuGet-based samples: ControlGallery, Explorer, Outlaw, plus DemoApp as a template reference rather than a playground.ModernFormsNext-<version>-sdk.zip: aggregate offline/reference bundle with source docs, HTML, samples, XML docs, API snapshots, release notes, licenses, and metadata.Release workflow
The release workflow restores the pinned DocFX tool, builds and tests the solution, packs and validates NuGet packages, then builds and validates all documentation archives before creating the GitHub Release or publishing NuGet packages.
SemVer is derived from the release tag. Release mode requires the exact
v<version>tag, verifies that the tag resolves togithub.sha, and records the full commit SHA in every bundle. The release assets and NuGet packages therefore correspond to the same tagged commit.Validation
git diff --check: PASSLocal dry-run
A local prerelease dry-run generated all four ZIP archives and passed
Validate-ReleaseDocumentation.ps1. Generated dry-run archives remain under ignoredartifacts/and are not committed.Compatibility / safety
The change is additive and does not alter runtime APIs, package versions, rendering, layout, or platform behavior. Bundle inputs are allowlisted from tracked files; validation rejects build outputs, packages, signing material, user-specific files, machine paths, traversal, broken offline links, mismatched metadata, and incorrect sample package versions.