Add `doNotThank` option to `@changeset/changelog-github` by beeequeue · Pull Request #460 · changesets/changesets

beeequeue · 2020-09-22T09:16:48Z

Takes a boolean (to disable thanking) or an array of names (to exclude them from being thanked).

Useful for if thanking people in the changelog is not necessary, e.g. thanking the main developer/maintainer over and over again, or in a private repo for work.

{
  "changelog": [
    "@changesets/changelog-github",
    {
      "repo": "org/repo",
      "doNotThank": true // Will not thank anyone
    }
  ],
}

{
  "changelog": [
    "@changesets/changelog-github",
    {
      "repo": "org/repo",
      "doNotThank": ["BeeeQueue"] // Will not thank BeeeQueue, but will thank anyone else (😢)
    }
  ],
}

Was written directly on GitHub so might have style problems and has not been tested yet

Test locally

atlassian-cla-bot · 2020-09-22T09:16:50Z

Hooray! All contributors have signed the CLA.

changeset-bot · 2020-09-22T09:16:51Z

💥 No Changeset

Latest commit: 99353b3

Merging this PR will not cause any packages to be released. If these changes should not cause updates to packages in this repo, this is fine 🙂

If these changes should be published to npm, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Andarist

I'm not sure if we'd like to proceed with this one, what are the benefits? What problems are caused by thanking all people? 🤔

Andarist · 2020-09-22T09:28:27Z

      });
      return `\n\n- ${links.commit}${
-        links.pull === null ? "" : ` ${links.pull}`
+        links.pull == null ? "" : ` ${links.pull}`


IMHO would be better to keep strong comparisons here - ===

Using strong comparisons on null is actually less safe, since using a weak one will catch both null and undefined, which you most often want to do.

I understand the difference - can undefined be even received here though?

I don't know, but it's good practice to always use the weak one since it catches more potential branches with no downsides, so I did it here. 🤷

Andarist · 2020-09-22T09:29:41Z

    }
+
+    const shouldThank = (user: string) => {
+      // Handle an array of names to not thank


those comments here don't seem super useful - the code is rather simple and handles its job quite literally, so this seems repetitive for me

I added them since there is no documentation for the option yet, so if someone goes into the code they will see it quickly without having to read the code.

Speaking of documentation, where should that be added?

Let's first discuss the merit of this option - don't want you to put too much work into this one if we decide not to proceed with this one in the end (I'm not saying that we won't, yet).

beeequeue · 2020-09-22T09:48:47Z

The main issues I see occurring is for example if you're the sole developer on a project. It's very nice to get links to the PRs and commits in the changelog, but seeing Thanks @BeeeQueue! on all changes on every version gets a bit old... This is why having the exclusion array is nice since it can automatically thank any contributors, but skip yourself.

The other situation I've encountered is at work, where we don't really need to be thanking all the people working on the project, so it feels out of place

Andarist · 2020-09-22T16:35:39Z

Isn't usually more information considered to be better than a lack of information? Those really seem quite harmless to me, even if a little bit excessive at times. You could rely on those to ask authors question regarding certain changes, rather than looking through git blame etc.

beeequeue · 2020-09-22T17:01:41Z

If you like it or use it you can just not disable it, it's an option and not forced on you. 😄

For example I realised that it's good that the PR authors get pinged on the release PR so they know it exists, so we're probably gonna keep it at work - but I still don't want it to endlessly thank myself on any personal projects I might use changelog-github for

Noviny · 2020-09-23T00:37:10Z

@beeequeue Thanks for the PR! I'd probably actually recommend making your own functions, rather than using one of our defaults. Our goal was to make writing new generation functions easy and letting the community build lots to suit their needs, rather than having 1 or 2 canon ones that have a bunch of configuration options.

I thoroughly acknowledge that writing new changelog generators is not where we want it to be at the moment though.

I'd be more interested in this as its own package than as an option for the existing one.

beeequeue · 2020-09-23T11:31:16Z

It feels very overkill to copy-paste a whole generator, etc. just to add an option, but if that's what you prefer I'll do that instead. 😕

Andarist · 2020-09-23T13:18:29Z

You probably could reuse our implementation and just strip away what u want with by manipulating the returned string.

We have to balance lean API and community demands, lean API doesnt only mean fewer options but also, more importantly, it means a reduced complexity of our implementation. If we add everything that is being asked for we’d end up with unmanageable code. If this issue arise again in the future we might reconsider stance on this particular option but for now i think it’s not needed as it has only been requested by you, so we cant really classify it as a popular demand.

Add doNotThank option

99353b3

Andarist reviewed Sep 22, 2020

View reviewed changes

Andarist requested review from Noviny and emmatown September 22, 2020 17:04

beeequeue closed this Sep 23, 2020

dimitrisnl mentioned this pull request Dec 3, 2021

[question] How to format changelog entries? #689

Closed

beeequeue mentioned this pull request Apr 23, 2026

Added disableThanks option #1255

Merged

Uh oh!

Uh oh!

Conversation

beeequeue commented Sep 22, 2020

Uh oh!

atlassian-cla-bot Bot commented Sep 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Sep 22, 2020

💥 No Changeset

Uh oh!

Andarist left a comment

Choose a reason for hiding this comment

Uh oh!

Andarist Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

beeequeue Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

Andarist Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

beeequeue Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

Andarist Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

beeequeue Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

Andarist Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

beeequeue commented Sep 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Andarist commented Sep 22, 2020

Uh oh!

beeequeue commented Sep 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Noviny commented Sep 23, 2020

Uh oh!

beeequeue commented Sep 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Andarist commented Sep 23, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

atlassian-cla-bot Bot commented Sep 22, 2020 •

edited

Loading

beeequeue commented Sep 22, 2020 •

edited

Loading

beeequeue commented Sep 22, 2020 •

edited

Loading

beeequeue commented Sep 23, 2020 •

edited

Loading