Renames CHANGELOG.md to match Hogwarts process #1576
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
belcherj
force-pushed
the
fix/rename-changelog-for-hogwarts-process
branch
from
b3bce96
to
5a2271d
Compare
dmsnell
added a commit
that referenced
this pull request
Apr 20, 2020
In #1576 we renamed `CHANGELOG.md` to `RELEASE-NOTES.txt` and in so doing we broke any integration which attempted to render the contents of the file as Markdown. The file continued to be written as a Markdown document but by renaming the extension we prevented any tools which rely on the extension to detect the type and so valuable tools like GitHub's diff viewer wouldn't show the contents of the file as they were written but instead as if they were plain text. In this patch we're renaming it back to a `.md` extension to reflect the reality of the file that it is indeed Markdown content. In so doing we're fixing the integrations that were broken in #1576.
codebykat
added a commit
that referenced
this pull request
Apr 23, 2020
* 1.16 release notes * Rename RELEASE-NOTES.txt to RELEASE-NOTES.md In #1576 we renamed `CHANGELOG.md` to `RELEASE-NOTES.txt` and in so doing we broke any integration which attempted to render the contents of the file as Markdown. The file continued to be written as a Markdown document but by renaming the extension we prevented any tools which rely on the extension to detect the type and so valuable tools like GitHub's diff viewer wouldn't show the contents of the file as they were written but instead as if they were plain text. In this patch we're renaming it back to a `.md` extension to reflect the reality of the file that it is indeed Markdown content. In so doing we're fixing the integrations that were broken in #1576. * typo fixes Co-authored-by: Dennis Snell <dennis.snell@automattic.com>
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.
Fix
Renames CHANGELOG.md to RELEASE-NOTES.txt to match Hogwarts process
Test
No testing needed
Review
Only one developer is required to review these changes, but anyone can perform the review.
Release
RELEASE-NOTES.txtwas updated in with:Renamed CHANGELOG.md to RELEASE-NOTES.txt