semantic-release / semantic-release/release-notes-generator

`release skip`-ed commits still get into release notes

Open
#531 0 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
368
Forks
55
Avg merge
10m
Merged PRs (30d)
1

Description

The documentation says that a commit can be excluded from the analysis by adding [skip release] here:

https://semantic-release.gitbook.io/semantic-release/support/faq#can-i-exclude-commits-from-the-analysis

And yet, those commits end up within the changelog file generated by the changelog plugin.
But looking closely, it is the release-notes-generator that provides the list of changes to be used.

So, I checked the release-notes-generator's code and found that it doesn't use the skip release filtration logic:

https://github.com/semantic-release/release-notes-generator/blame/master/index.js#L48

which is present in the core:

https://github.com/semantic-release/semantic-release/blame/master/lib/definitions/plugins.js#L22

I see that this was added pretty long ago (3 years ago), but nothing seems to be done about it.

So, is it intentional?
Or is it just some barely used feature that everybody forgot about and left the plugin outdated with inconsistent logic?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the filtering logic referenced in release-notes-generator/index.js with semantic-release/lib/definitions/plugins.js. Determine whether [skip release] commits are expected to be excluded from generated release notes, then verify the behavior with the project's existing tests or a focused reproduction; done means the intended behavior is documented and consistently enforced.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
release
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.