docs(changes): backfill the changelog from 1.3.2 to 1.10.0 - #408
Merged
Merged
Conversation
CHANGES stopped at 1.3.1, so twelve releases were missing. The GitHub release notes for 1.3.2..1.9.1 are bare lists of PR numbers, so the entries are restored from the PR/issue titles and cross-checked against the commit log between the tags. That log also adds a few user visible changes the release notes left out: the switch to /download/release/index.json and dropping io.js in 1.4.0, dropping python3.4-3.6 in 1.7.0 and dropping the "packaging" dependency in 1.9.0. The unreleased section gains the six commits made after the 1.10.0 tag that were never written down: the tarfile filter='data' fix, Solaris/illumos support, the Windows predeactivate hooks, error handling around the node installation, the leftover debug print that 1.10.0 shipped, and semver ranges in --node.
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.
Why
CHANGESstopped at 1.3.1 (June 2018), so twelve releases - 1.3.2 through 1.10.0 - were never written down. Anyone reading the changelog sees a seven year hole and has to fall back on the git log.What
Restored 1.3.2 .. 1.10.0. The GitHub release notes for 1.3.2..1.9.1 are bare lists of PR numbers with no descriptions, so each entry here is reconstructed from the PR/issue title and cross-checked against the commit log between the tags. 1.10.0 already had generated notes.
The commit log also turned up user visible changes the release notes left out, so they are included:
/download/release/index.jsonfor version discovery, and dropping io.js support#352, which dropped thepackagingdependency added by#338in the same release - listing only#338would be misleadingLink targets were checked one by one against the API, since several of the referenced numbers are issues rather than PRs (
#225,#249,#296,#356).Filled in the unreleased section. Six commits made after the 1.10.0 tag had no entry:
filter='data'intarfile.extractall(address deprecation warning in tarfile.TarFile.extract all in Python … #380)predeactivatehooks for Windowsprintthat leaked a dict to stdout on every version detection (spurious print? #390) - a regression from Check host platform when findingnodeversion #363 that shipped in 1.10.0--node(feat(nodeenv): accept npm-style semver ranges in --node #393)The existing "check for how
activateis called" entry was the only one without a link; it now points at #384.Purely infrastructural commits (linters, CI workflows, dev dependencies, AUTHORS) are left out.
Checks
The file parses as reStructuredText through docutils with no warnings.