fix: successComment value in @semantic-release/github config

[dkoo]

All Submissions:

• Have you followed the Newspack Contributing guideline?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

Fixes blocking errors in the release script (example):

[11:18:42 PM] [semantic-release] › ✖  Failed step "fail" of plugin "@semantic-release/github"
[11:18:42 PM] [semantic-release] › ✖  EINVALIDSUCCESSCOMMENT Invalid `successComment` option.
The successComment option (https://github.com/semantic-release/github/blob/master/README.md#successcomment) if defined, must be a non empty String.

Your configuration for the successComment option is true.

[11:18:42 PM] [semantic-release] › ✖  EINVALIDSUCCESSCOMMENT Invalid `successComment` option.
The successComment option (https://github.com/semantic-release/github/blob/master/README.md#successcomment) if defined, must be a non empty String.

Your configuration for the successComment option is true.

The automated release failed with AggregateError: 
    SemanticReleaseError: Invalid `successComment` option.
        at module.exports (/home/circleci/project/node_modules/@semantic-release/github/lib/get-error.js:6:10)
        at /home/circleci/project/node_modules/@semantic-release/github/lib/verify.js:43:23
        at Array.reduce (<anonymous>)
        at module.exports (/home/circleci/project/node_modules/@semantic-release/github/lib/verify.js:40:54)
        at verifyConditions (/home/circleci/project/node_modules/@semantic-release/github/index.js:27:9)
        at validator (/home/circleci/project/node_modules/semantic-release/lib/plugins/normalize.js:34:30)
        at /home/circleci/project/node_modules/semantic-release/lib/plugins/pipeline.js:37:40
        at next (/home/circleci/project/node_modules/p-reduce/index.js:17:9)
        at runMicrotasks (<anonymous>)
        at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at /home/circleci/project/node_modules/semantic-release/lib/plugins/pipeline.js:54:11
    at async Object.pluginsConf.<computed> [as verifyConditions] (/home/circleci/project/node_modules/semantic-release/lib/plugins/index.js:80:11)
    at async run (/home/circleci/project/node_modules/semantic-release/index.js:103:3)
    at async module.exports (/home/circleci/project/node_modules/semantic-release/index.js:269:22)
    at async run (/home/circleci/project/node_modules/newspack-scripts/scripts/release.js:129:20)

In the current release, successComment evals to true if the base branch is a release, alpha, or hotfix branch. true isn't a valid value for this option in the @semantic-release/github plugin—if we want the default commenting behavior, we should simply omit the option from the config object.

This patch only assigns successComment a value of false (meaning we don't want @semantic-release to post a comment to the PR) if the base branch isn't a release, alpha, or hotfix branch. If the base branch IS one of these, omitting successComment from the config should result in @semantic-release posting a default success message to the PR.

How to test the changes in this Pull Request:

Can't think of a way to test this without letting it fly..

Other information:

• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes, as applicable?
• Have you successfully ran tests with your changes locally?

[laurelfulford]

Thanks @dkoo! Looks good, let's give it a shot! 🤞

[matticbot]

🎉 This PR is included in version 5.5.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[matticbot]

🎉 This PR is included in version 5.6.0-alpha.8 🎉

The release is available on:

• npm package (@alpha dist-tag)
• GitHub release

Your semantic-release bot 📦🚀