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

chore: add "Thanks" section to release-please configuration #5276

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

TG199
Copy link
Contributor

@TG199 TG199 commented Dec 21, 2024

PR Checklist

Overview

This PR modifies the release-please configuration to include contributor acknowledgments in our release notes, similar to typescript-eslint's format. This change will:

  • Add a "Thank You" section at the bottom of release notes listing all contributors
  • Keep the existing changelog sections and emojis
  • Maintain clean, readable formatting of changes

@voxpelli
Copy link
Member

Can you give some reference to how this works? I wasn't aware that release-please could do this, so would love to know where I missed it

@TG199
Copy link
Contributor Author

TG199 commented Dec 23, 2024

Oh hey Sir, unfortunately this doesn't work as expected, however, I'm trying out other methods like writing a script or creating a custom plugin for it.

- Fetches contributor details for merged PRs using GitHub's API.
- Enhances auto-generated release notes by tagging contributors.
- Prepares for integration into the release workflow.

A special holiday update to spread cheer and gratitude this Christmas season! 🎅🎁

Resolves mochajs#5272 (ho ho ho)
@@ -102,7 +102,7 @@ describe('ParallelBuffered', function () {
describe('on EVENT_RUN_END', function () {
it('should remove all listeners', function () {
runner.emit(EVENT_RUN_END);
expect(runner.listeners(), 'to be empty');
expect(runner.listenerCount(EVENT_RUN_END), 'to equal', 0);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 if there's something wrong with this test, it should be fixed in its own issue -> PR. Any CI failures also happening on main don't need to block or be fixed by this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh okay, got it.

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this is ready for review, but I have a design change request on it anyway. Posting now just in case it saves you some time going down a different path. Cheers!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Change request] As a design point, I don't think taking on the burden of a full script is ideal. Assuming release-please doesn't have contribution thanks as a core feature, I think the next best thing would be a plugin. Which is a thing that can be made: https://github.com/googleapis/release-please/blob/3bae6137f939a4db2df1d32436453d1ac2a41e9f/docs/manifest-releaser.md#plugin-usage

googleapis/release-please#2221 tracks them adding more docs and also links to some information + existing plugins.

Is that an approach you think could work?

@JoshuaKGoldberg JoshuaKGoldberg added the status: waiting for author waiting on response from OP - more information needed label Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting for author waiting on response from OP - more information needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🛠 Repo: Credit contributors in release notes
4 participants