search

JetBrains / intellij-platform-plugin-template

Template repository for creating plugins for IntelliJ Platform
Apache License 2.0
3.04k stars 614 forks source link

Changelogs in `plugin.xml` and in Draft Release are different #371

Open ris58h opened 1 year ago

ris58h commented 1 year ago

patchPluginXml Gradle task uses changes of the current version but Build workflow uses Unreleased changes.

Steps to reproduce:

  1. Have CHANGELOG.md with empty Unreleased section.
  2. Have pluginVersion Gradle property set to any release version in CHANGELOG.md except of Unreleased.
  3. Run workflows in .github/workflows/build.yml.

Expected behavior: Changelogs in plugin.xml and in Draft Release are the same.

Additional context: Changelogs in plugin.xml and in Draft Release are different.

ris58h commented 1 year ago

It seems like all it's done later on release. I only use build workflow without release workflow and I upload my plugin manually so it was confusing to me that a draft release doesn't contain an actual changes (and an artifact).

Anyway, being able to review an actual changes in a draft release would be useful.

ciscorucinski commented 1 year ago

It does seem to be process-specific and that can cause unexpected behavior. Maybe there could be a more process-agnostic approach?

ris58h commented 1 year ago

I believe it's possible to make it more process-agnostic. I don't see why we shouldn't put an actual changelog in a draft release.

An artifact is a different thing and as I get from README there is a reason for not putting it in a draft release. May be we should introduce a settings to make it optional but it's a different question anyway and doesn't relate to the changelog.