Open HonkingGoose opened 1 year ago
Do we intend to also,?
fetchReleaseNotes
Release Notes
to Change logs
It's Changelog or Changelogs with no space and yes we should probably aim to be as consistent with that as possible
I just found a possible complication: there are release notes but also a CHANGELOG
file. 🙃
Dependabot shows two separate expandable sections: one for Release notes and one for Changelog.
Dependabot says what's the source of the text:
// Dependabot message about Releases
<p><em>Sourced from <a href="https://github.com/squidfunk/mkdocs-material/releases">mkdocs-material's releases</a>.</em></p>
// Dependabot text about Changelog file
<p><em>Sourced from <a href="https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG">mkdocs-material's changelog</a>.</em></p>
I just wanted to mention this whole thing, so you can think about ways to prevent confusion later down the line. 😄
Describe the proposed change(s).
Use the word
changelogs
in our code instead ofrelease notes
. I'll let somebody else refactor the code.Describe why we need/want these change(s).
Follow-up after discussion #23109. Right now we use
changelogs
andrelease notes
. We decided to use the wordchangelogs
.Related issue:
23140