docs: add retroactive CHANGELOG.md#181
Merged
Merged
Conversation
Reconstructs release history from git log of PSDepend/PSDepend.psd1, covering 0.0.1 through 0.3.0 plus an [Unreleased] section for work merged since the last published release. Format follows Keep a Changelog; the file path matches the ReleaseNotes URL already referenced in PSDepend.psd1. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a root-level CHANGELOG.md intended to retroactively document PSDepend’s release history and provide a valid target for the module manifest’s existing PSData.ReleaseNotes URL.
Changes:
- Introduces
CHANGELOG.mdfollowing a Keep a Changelog-style structure with an[Unreleased]section and historical versions. - Captures reconstructed release notes for versions 0.0.1 through 0.3.0 and summarizes post-0.3.0 work.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - NuGet is now bootstrapped lazily, only when a `Nuget`/`PSGalleryNuget` dependency is used (#175). | ||
| - Renamed default branch references from `master` to `main`. | ||
| - Updated `README` and examples for `PowerShellOrg` ownership. | ||
| - Allowed overriding the dependency name in the `Github` dependency type (#121). |
| - `Import-PSDependModule`: sanitize the version string passed to `Import-Module` (#140). | ||
| - `Git`: use the full `Dependency.Target` path when the target doesn't exist (#169). | ||
| - `Git`: remove dependency on the `git.exe` extension for cross-platform support. | ||
| - `Github`: speed up downloads by suppressing `Invoke-RestMethod` progress (#122). |
| - Tests now use `TestDrive` instead of `TargetPath`. | ||
| - `psake` build task allows `psd1` version overrides. | ||
| - Unmarked `Github` as experimental. | ||
| - Honor arbitrary target path logic for `Github` types. |
| ## [0.1.49] - 2017-03-19 | ||
|
|
||
| ### Added | ||
| - `Github` dependency type with default target handling. |
| - `AcceptLicense` for `PSRepositoryModule`. | ||
| - `Nuget` dependency type for pulling packages from arbitrary NuGet feeds, with custom DLL name support and `exe` support. | ||
| - Credential support across PSGallery scripts (`PSGalleryModule`, `PSGalleryNuget`) and `Invoke-PSDepend`; credentialed NuGet feed search; credential misconfiguration warning. | ||
| - `Funding.yml`. |
| - `Chocolatey` provider and accompanying Pester tests. | ||
| - SemVer / prerelease handling, including a PowerShell version constraint to avoid conflicts with the native `SemanticVersion` class in PS 6+. | ||
| - `AcceptLicense` and `AllowPrerelease` parameters on `PSGalleryModule` (passed only when specified). | ||
| - `AcceptLicense` for `PSRepositoryModule`. |
Drop PR-number citations in favor of self-contained, technically specific bullets that describe the actual code change (file/function/ parameter names, behavior contracts, migration notes) — establishing the style going forward. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Keep the descriptive style but cite PR numbers in parens at the end of each bullet where a PR exists in the commit history. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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.
Summary
CHANGELOG.mdat the repo root, reconstructed retroactively from the git history ofPSDepend/PSDepend.psd1.PSDepend/PSDepend.psd1(line 109), wherePrivateData.PSData.ReleaseNotesalready points atCHANGELOG.mdonmainbut the file did not exist.Why retroactive
The module has shipped 8 versions but never carried a changelog. Reconstructing it now gives a single place to read project history, makes the existing
ReleaseNoteslink resolve, and creates a landing spot for future releases to append to instead of starting from scratch.Test plan
CHANGELOG.mdrenders correctly on GitHub.PSDepend/PSDepend.psd1line 109 (ReleaseNotes) now resolves once merged tomain.git logto confirm accuracy.🤖 Generated with Claude Code