renovatebot / renovate

Home of the Renovate CLI: Cross-platform Dependency Automation by Mend.io
https://mend.io/renovate
GNU Affero General Public License v3.0
17.45k stars 2.29k forks source link

Use word `changelogs` in code #23139

Open HonkingGoose opened 1 year ago

HonkingGoose commented 1 year ago

Describe the proposed change(s).

Use the word changelogs in our code instead of release 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 and release notes. We decided to use the word changelogs.

Related issue:

RahulGautamSingh commented 1 year ago

Do we intend to also,?

  1. rename the config options like fetchReleaseNotes
  2. change the pr body section Release Notes to Change logs
rarkins commented 1 year ago

It's Changelog or Changelogs with no space and yes we should probably aim to be as consistent with that as possible

HonkingGoose commented 1 year ago

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. 😄