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

🐛 Bug: GH Release page should only include user-facing changes #1913

Closed
3 tasks done
michaelfaith opened this issue Jan 23, 2025 · 3 comments · Fixed by #1924
Closed
3 tasks done

🐛 Bug: GH Release page should only include user-facing changes #1913

michaelfaith opened this issue Jan 23, 2025 · 3 comments · Fixed by #1924
Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(

Comments

@michaelfaith
Copy link
Contributor

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Expected

#1810 addressed the CHANGELOG side of #1493, but not the GH Release Page. The release pages should similarly only show changes that are user-facing (i.e. not include chore PRs).

Actual

It currently shows all changes. https://github.com/JoshuaKGoldberg/create-typescript-app/releases/tag/v1.77.1

Additional Info

The gh function of release-it isn't nearly as featureful as the changelog generation (powered by conventional-changelog), so it'll require a bit more manual customization for it to behave similarly. They do provide the ability to pass in a custom function, which could be used to filter out unwanted changes: https://github.com/release-it/release-it/blob/main/docs/github-releases.md#function

e.g.

{
  github: {
    release: true,
    releaseNotes(context) {
      return context.changelog.split('\n').slice(1).filter((change) => !change.startsWith('chore')).join('\n');
    }
  }
}
@michaelfaith michaelfaith added the type: bug Something isn't working :( label Jan 23, 2025
@JoshuaKGoldberg JoshuaKGoldberg added the status: accepting prs Please, send a pull request to resolve this! label Jan 23, 2025
michaelfaith added a commit to JoshuaKGoldberg/eslint-plugin-package-json that referenced this issue Jan 25, 2025
This change is a POC to address JoshuaKGoldberg/create-typescript-app#1913.  Since it's not something we can really test locally, I figured we test it out here, and then, if successful, I can make the updates upstream.

Here we've changed the release-it config from json to js, which allows us to create a custom function for `github.releaseNotes`.  Using the context provided by release-it, we can filter by groups that we want to keep, and organize them into the same groups that we're organizing for the CHANGELOG (via conventional-changelog)
michaelfaith added a commit to JoshuaKGoldberg/eslint-plugin-package-json that referenced this issue Jan 25, 2025
This change is a POC to address JoshuaKGoldberg/create-typescript-app#1913.  Since it's not something we can really test locally, I figured we test it out here, and then, if successful, I can make the updates upstream.

Here we've changed the release-it config from json to js, which allows us to create a custom function for `github.releaseNotes`.  Using the context provided by release-it, we can filter by groups that we want to keep, and organize them into the same groups that we're organizing for the CHANGELOG (via conventional-changelog)
michaelfaith added a commit to JoshuaKGoldberg/eslint-plugin-package-json that referenced this issue Jan 25, 2025
This change is a POC to address JoshuaKGoldberg/create-typescript-app#1913.  Since it's not something we can really test locally, I figured we test it out here, and then, if successful, I can make the updates upstream.

Here we've changed the release-it config from json to js, which allows us to create a custom function for `github.releaseNotes`.  Using the context provided by release-it, we can filter by groups that we want to keep, and organize them into the same groups that we're organizing for the CHANGELOG (via conventional-changelog).  I updated the prepare action to use node 22, which will allow us to use the `Object.groupBy` api (introduced in v21).  Since 22 is now LTS, this felt like a reasonable change.
@JoshuaKGoldberg
Copy link
Owner

@all-contributors please add @michaelfaith for bug.

🤖 Beep boop! This comment was added automatically by all-contributors-auto-action.
Not all contributions can be detected from Git & GitHub alone. Please comment any missing contribution types this bot missed.
...and of course, thank you for contributing! 💙

Copy link
Contributor

@JoshuaKGoldberg

I've put up a pull request to add @michaelfaith! 🎉

JoshuaKGoldberg added a commit that referenced this issue Jan 27, 2025
Adds @michaelfaith as a contributor for bug.

This was requested by JoshuaKGoldberg [in this
comment](#1913 (comment))

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
Co-authored-by: Josh Goldberg <[email protected]>
@JoshuaKGoldberg JoshuaKGoldberg added status: in discussion Not yet ready for implementation or a pull request and removed status: accepting prs Please, send a pull request to resolve this! labels Jan 27, 2025
@JoshuaKGoldberg
Copy link
Owner

Marking as status: in discussion per JoshuaKGoldberg/eslint-plugin-package-json#772 (comment).

@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Please, send a pull request to resolve this! and removed status: in discussion Not yet ready for implementation or a pull request labels Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants