(GH-189) Add semantic changelog #193
Merged
Conversation
This file contains 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
Prior to this change, the project didn't maintain a changelog file. Instead, it relied on generation of release notes from PRs. As raised in PowerShell#189, the auto-generated changelog is limited in its effectiveness for changelog readers outside of the maintenance team. The entries depend entirely on the PR titles, they aren't organized by kind or relative importance, and they can't link to documentation. This change: - Defines the changelog by hand, adhering to the KAC format with an extension for how related work items are displayed, using a details element to collapse them. - Fully documents the set of user-facing changes that are included in the `alpha.2` release, including summaries and related work items and linking to documentation where appropriate. - Resolves PowerShell#189
SteveL-MSFT
approved these changes
Sep 8, 2023
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.
PR Summary
This change:
alpha.2release, including summaries and related work items and linking to documentation where appropriate.PR Context
Prior to this change, the project didn't maintain a changelog file. Instead, it relied on generation of release notes from PRs.
As raised in #189, the auto-generated changelog is limited in its effectiveness for changelog readers outside of the maintenance team. The entries depend entirely on the PR titles, they aren't organized by kind or relative importance, and they can't link to documentation.
Note
Unless/until we get tooling to make maintaining this changelog easier, I'm happy to author future entries by hand as part of the documentation effort. From my perspective, especially for the audience we're working with during the alpha development, the changelog is a form of project-level reference documentation.