Repository navigation
doc: dependencies apart, a release's changelog since the previous release - #121
Merged
Merged
Conversation
…ease - A built version's frozen schemas hold its dependencies' and std's: they were documented as the package's own modules. The model now lists them apart (core#163), each with only what the package reaches, and a version's schemas for changelogs are its own alone (they held every dependency, so the unreleased state always looked changed). - A release carries its changes since the previous release, compared directly between the two trees; a dev build (and the unreleased state) past the first build after a release, its changes since that release. Steps stay on the trimmed list, which the compare page composes; the cache key names every commit a version's changelogs start from. - Pins: comline-core on core#163, the doc renderers and comline-codegen on generation#104, the generators on comline-rust#92 and comline-typescript#111.
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.
CLI half of core#163 / generation#104.
Dependency bug, root cause. A built version's root tree stores every compiled schema (
schema_<n>): the package's own, its dependencies' (localdeps::greeting) and std's (std::http).comline docloaded them all withhistory::load_schemas, andmodel_frozenbuilt its index with no dependency names, so every schema counted as an own module. Nowfrozen()passes the vendored dependency names (dep_<name>entries, plusstd) and the model lists them apart independencies, by reach. The same fix makes each version's schemas its own alone, which also stops the unreleased state from always looking changed (built schemas held std's, the working tree's didn't).Release changelogs. A release now carries its changes since the previous release, compared directly between the two built trees (
span: release); its page shows that, headed e.g.0.1.0 to 0.2.0. A dev build (or the unreleased state) past the first build after a release carries its changes since that release (since_release), linked from its page under its step. Steps are still computed on the trimmed list, so the compare page composes them as before. The cache key names every commit a version's changelogs start from.Tests.
a_release_changelog_covers_everything_since_the_previous_release(release, dev build, release from the same files: the second release lists the dev build's changes; compare.js counts the change once) anddependencies_are_listed_apart_by_reach(std::httpreached,std::validatorsnot, no std pages, hosted links, plain brand).Pins: comline-core on core#163, comline-codegen + doc renderers on generation#104 (abba324, the commit the generators pin), comline-rust#92, comline-typescript#111.