JetBrains / intellij-platform-plugin-template

Template repository for creating plugins for IntelliJ Platform
Apache License 2.0
3.05k stars 618 forks source link

Release workflow results in malformed change notes being embedded into JAR and published to JetBrains Marketplace. #341

Closed nelsonjchen closed 3 months ago

nelsonjchen commented 1 year ago

Describe the bug:

image

The change-notes value in the plugin that is uploaded to the marketplace is malformed. At a glance, this appears to be a malformed derivative of a converting some formatting for GitHub's format.

https://github.com/JetBrains/intellij-platform-plugin-template/blob/43896299abbbf5ea802604530b7305da52c06675/.github/workflows/release.yml#L38-L49

Steps to reproduce:

  1. Get a draft release created.
  2. Publish the release, kicking off the release workflow.
  3. Check the change notes inside the resulting zip to the JAR and/or Jetbrains Marketplace listing.

Expected behavior:

Change notes is not malformed on any target.

Additional context:

nelsonjchen commented 1 year ago

Ah, this is trying to pass to the next step! The next step uses the output immediately but does not reverse the encoding.

nelsonjchen commented 1 year ago

I just base64'd it for now. https://github.com/nelsonjchen/Colorized-Project/blob/fd42526ccd0d99f8527574210ea55df5fb5e35ea/.github/workflows/release.yml#L46

I'll probably update with whatever solution is done for this later.

YannCebron commented 3 months ago

This seems obsolete in the latest version of release.yml https://github.com/JetBrains/intellij-platform-plugin-template/blob/main/.github/workflows/release.yml#L41