@semantic-release/github adds comments to the wrong issues

[stalniy]

It looks like @semantic-release/github adds comments to the wrong issues when used in monorepo

[pmowrer]

I think you're right! Haven't had a chance to look into it. Here's a few related issues:

semantic-release/github#50
semantic-release/github#63

Help wanted!

[pmowrer]

As a temporary workaround, the comments can be turned off by overriding the default success and fail plugins (e.g. set them to empty arrays) in the release configuration

[stalniy]

I did some investigation and see that github/success function receives context.commits and that array of commits are not filtered by semanatic-release-monorepo.

Will try to understand why is that

[stalniy]

semantic-release looking for all commits starting until last release:

  const commits = await getCommits(lastRelease.gitHead, options.branch, logger);

Later it passes this array of commits to every plugin call, in options.commits. That's why github plugin receives the list of all commits, parses them and send comments to wrong issues.

[pmowrer]

Haven't had a chance to look at this... Thanks for the research!

Sounds like maybe all we need to do is wrap the success plugin like we do the others. The primary reason this library even exists is to allow monkey patching the output of getCommits to filter commits based on package since semantic-release won't allow it.

[milesj]

Has there been an update on this? It's pretty noise right now every time a release happens.

[cpinnix]

@milesj I don't have an update for you at the moment. But we will be looking into this in the next week or so.

[milesj]

Our releases are taking longer and longer because it's adding so many comments to PRs. If someone can point me to the location of what to fix, I can take a stab at it. Maybe wrapping the success plugin?

[prisis]

Is there a way to help you?

[pmowrer]

I have a branch up that should fix this, github-comments-fix, if anyone's willing to give it a try.

[ghost]

Has anyone tried this? Can we get this fixed in the package?

[stalniy]

Just FYI:

I switched to solution semantic-release/semantic-release#193 (comment)

Similar hack but is much simpler and augments only single package. Haven’t tried to enable release comments however. Better cross-release support

[ghost]

Just FYI:

I switched to solution semantic-release/semantic-release#193 (comment)

Similar hack but is much simpler and augments only single package. Haven’t tried to enable release comments however. Better cross-release support

You should check out semantic-release-plus! Should be essentially the same, but it’s always kept up to date with semantic-release itself.

[travi]

I have a branch up that should fix this, github-comments-fix, if anyone's willing to give it a try.

@pmowrer i've been testing this branch out a fair amount today, and it seems to be working as i would expect. what would it take to include this in a published release (even a pre-release would be ok with me)?

[pmowrer]

Thanks so much for trying it out @travi! That's good enough for me... just published a new release with the fix!

[pmowrer]

🎉 This issue has been resolved in version 7.0.3 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[travi]

thanks!