Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: remove title from the release notes #327

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

felipecrs
Copy link

This information is redundant in the GitHub Release.

BREAKING CHANGE: The title is now removed from the release notes by
default. You can disable the removal of title/restore the old behavior
with removeTitleFromReleaseNotes: false.

Fixes: #316

@felipecrs
Copy link
Author

felipecrs commented Dec 28, 2020

I suggest this PR to be merged right after #326 so we can prevent 2 new major releases in a row.

@felipecrs
Copy link
Author

felipecrs commented Dec 28, 2020

This PR also adds configuration of VSCode, so it runs xo --fix automatically on Javascript files.

This information is redundant in the GitHub Release.

BREAKING CHANGE: The title is now removed from the release notes by
default. You can disable the removal of title/restore the old behavior
with [`removeTitleFromReleaseNotes: false`](https://github.com/semantic-release/github#removetitlefromreleasenotes).

Fixes: semantic-release#316
@eshepelyuk
Copy link

Should not be this addressed in changelog generation plugin, rather than github specific release ?

@felipecrs
Copy link
Author

No, because the changelog must contain the title. The only place where this information would be redundant is in the GitHub Releases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Duplicated information in release notes.
2 participants