feat: allow conditional skip on success and fail comments by babblebey · Pull Request #874 · semantic-release/github

babblebey · 2024-07-10T18:29:14Z

This PR Intend to transfer the flow from semantic-release/gitlab#730 to the github plugin. It introduces the new properties into the configuration option, which are used to perform the stated function.

failCommentCondition - used to state the conditions by which the failComment is posted or not
successCommentCondition - used to state the conditions by which the successComment is posted or not and where it is posted

Changes Made

Added deprecation notice for failTitle, failComment and successComment set as false
Introduced logic to fetch more data for issues parsed from pull request body and commit messages to aid successCommentCondition filtering (more datails in feat: allow conditional skip on success and fail comments #874 (comment))
Introduced utility to help perform stated functionality
- buildRelatedIssuesQuery - Builds GraphQL query for fetching PRs/Commits related Issues to a list of commit hash (sha) from parsedIssue number
- buildAssociatedPRsQuery - Builds GraphQL query for fetching associated PRs to a list of commit hash (sha)
- buildIssuesOrPRsFromResponseNode - Build associatedPRs or RelatedIssues object (into issue-like object with pull_request property) from the GraphQL repository response

Related Issue

Closes#360
Closes#359
Closes#666
Resolves#529

Screencast/Screenshot

Demo "successCommentCondition": false - Do not add Success comment to any Issue or PR

screencast-bpconcjcammlapcogcnnelfmaeghhagj-2024.3.mp4

Demo "successCommentCondition": "<% return issue.pull_request; %>" - Add Success comment to only Pull Requests

screencast-bpconcjcammlapcogcnnelfmaeghhagj-2024.4.mp4

Demo "successCommentCondition": "<% return !issue.pull_request; %>" - Add Success comment to only Issues

screencast-bpconcjcammlapcogcnnelfmaeghhagj-2024.5.mp4

…solve-config`

…ccess` scipt

…n" is "false"`

…when "failCommentCondition" is "false"`

babblebey

Hello @fgreinacher,

Kindly help me clarify these observations... see review comments..

…t comment on existing issues when "failCommentCondition" is disallows it`

…mentCondition" is "false"`

JonasSchubert

As @fgreinacher said, awesome you picked that up so quickly, @babblebey , thanks a lot! Just found a small typo in one unit test description, beside that it looks good for me.
Will you also add unit tests for success.js?

Co-authored-by: Jonas Schubert <jonas.schubert.projects@web.de>

babblebey · 2024-07-16T21:31:57Z

Will you also add unit tests for success.js?

Yea, working on that 😉

…sociatedPR using the "successCommentCondition"`

…R when "successCommentCondition" disables it`

…github.com/semantic-release/github into feat/conditional-success-fail-comment-skip

…R when "successCommentCondition" disables it`

…Condition`

Co-authored-by: Gregor Martynus <39992+gr2m@users.noreply.github.com>

…github.com/semantic-release/github into feat/conditional-success-fail-comment-skip

…ssues created by "Bots"'`

github-actions · 2024-09-02T16:46:44Z

🎉 This issue has been resolved in version 10.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

babblebey added 7 commits July 10, 2024 19:17

feat: add failCommentCondition to fail script
304d023

feat: add successCommentCondition and failCommentCondition to `re…
120d391
…solve-config`

feat: add successCommentCondition and failCommentCondition to `su…
ec8f4d6
…ccess` scipt

fix(build): lint
508e066

test: add fail case `Does not post comments if "failCommentConditio…
f319896
…n" is "false"`

test: add fail case for `Does not post comments on existing issues …
5983b75
…when "failCommentCondition" is "false"`

Merge branch 'master' into feat/conditional-success-fail-comment-skip
da630b1

babblebey commented Jul 14, 2024
View reviewed changes

Comment threadlib/success.js Outdated

babblebey added 3 commits July 14, 2024 12:03

Merge branch 'master' into feat/conditional-success-fail-comment-skip
a71ee8a

Merge branch 'master' into feat/conditional-success-fail-comment-skip
8231ec0

fix(build): lint
f516292

babblebey commented Jul 15, 2024
View reviewed changes

Comment threadtest/fail.test.js

babblebey commented Jul 15, 2024
View reviewed changes

Comment threadlib/fail.js

babblebey commented Jul 15, 2024
View reviewed changes

fgreinacher requested a review from JonasSchubert July 16, 2024 09:56

test(fail): add case for `Post new issue if none exists yet, but don'…
460d475
…t comment on existing issues when "failCommentCondition" is disallows it`

babblebey commented Jul 16, 2024
View reviewed changes

Comment threadlib/fail.js

test(success): add case `Does not comment on issues/PR if "successCom…
7d2b4de
…mentCondition" is "false"`

JonasSchubert suggested changes Jul 16, 2024
View reviewed changes

Comment threadtest/fail.test.js Outdated

Update test/fail.test.js
e55733b
Co-authored-by: Jonas Schubert <jonas.schubert.projects@web.de>

babblebey added 7 commits July 18, 2024 22:21

test(success): add case for `Add comment and label to found issues/as…
2156d92
…sociatedPR using the "successCommentCondition"`

nits
6f46d09

test(success): add case for `Does not comment/label found associatedP…
e32cc69
…R when "successCommentCondition" disables it`

Merge branch 'feat/conditional-success-fail-comment-skip' ofhttps://…
30b6f38
…github.com/semantic-release/github into feat/conditional-success-fail-comment-skip

Merge branch 'master' into feat/conditional-success-fail-comment-skip
5d9e5d5

test(success): improve case `Does not comment/label found associatedP…
81c9ff0
…R when "successCommentCondition" disables it`

doc: add documentation for successCommentCondition and `failComment…
a82c2b8
…Condition`

gr2m reviewed Jul 19, 2024
View reviewed changes

Comment threadlib/success.js Outdated
Comment threadlib/fail.js Outdated
Comment threadlib/fail.js Outdated

Update lib/success.js
219386c
Co-authored-by: Gregor Martynus <39992+gr2m@users.noreply.github.com>

babblebey mentioned this pull request Aug 19, 2024
Bump minimum bound for peer dependencies with semantic-release#902
Closed

babblebey added 13 commits August 21, 2024 16:36

Merge branch 'master' into feat/conditional-success-fail-comment-skip
201a1bb

test: update integrations test
d41a1df

test: address PR and Issue naming in logs in success
6473eb9

refactor: why the Promise.all()? Removed it haha
94f3975

feat: set default type param in buildIssuesOrPRsFromResponseNode
e29b312

feat: address edge cases
474a28a

Merge branch 'master' into feat/conditional-success-fail-comment-skip
cbd0128

Merge branch 'feat/conditional-success-fail-comment-skip' ofhttps://…
1ef47af
…github.com/semantic-release/github into feat/conditional-success-fail-comment-skip

Merge branch 'master' into feat/conditional-success-fail-comment-skip
34795a5

test: fixed matchers in graphql request in success units
8ee3679

build: lint
f617843

Merge branch 'feat/conditional-success-fail-comment-skip' ofhttps://…
e336619
…github.com/semantic-release/github into feat/conditional-success-fail-comment-skip

docs: add ignore bots pr/issues example
15c3089

babblebey mentioned this pull request Aug 30, 2024
fix: replace searchAPI usage with GraphQL in findSRIssue util #907
Merged

babblebey marked this pull request as ready for review August 30, 2024 20:33

babblebey added 5 commits September 2, 2024 15:54

Merge branch 'master' into feat/conditional-success-fail-comment-skip
f91e8e9

fix: user issue number over id
ff17066

test: improve case `'Does not comment/label associatedPR and relatedI…
601303d
…ssues created by "Bots"'`

doc: modify buildIssuesOrPRsFromResponseNode documentation
367047d

Merge branch 'master' into feat/conditional-success-fail-comment-skip
0d3cd0f

babblebey merged commit e097d1c into masterSep 2, 2024

babblebey deleted the feat/conditional-success-fail-comment-skip branch September 2, 2024 16:46

github-actionsBot added the released label Sep 2, 2024

babblebey mentioned this pull request Sep 2, 2024
Feature request: exclude PRs with specific labels from commenting #361
Closed

tejasbagal1 mentioned this pull request Sep 2, 2024
CI failing with error - Field 'canBeRebased' doesn't exist on type 'PullRequest' #910
Closed

oscard0m mentioned this pull request Sep 13, 2024
refactor(glob-assets): use 'tinyglobby' instead of 'globby' as dependency #925
Draft

coderabbitaiBot mentioned this pull request Jul 10, 2026
fix(release): publish with release bot YKDBontekoe/KYNOS#92
Merged

coderabbitaiBot mentioned this pull request Aug 7, 2026
Develop -> Main SM17-YoonDongJu/Backend#199
Merged

Navigation Menu

Uh oh!

feat: allow conditional skip on success and fail comments - #874

feat: allow conditional skip on success and fail comments#874
babblebey merged 79 commits into
masterfrom
feat/conditional-success-fail-comment-skip

babblebey commented Jul 10, 2024•
edited by hearts Bot
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

babblebey left a comment

Uh oh!

Uh oh!

JonasSchubert left a comment

Uh oh!

Uh oh!

babblebey commented Jul 16, 2024•
edited by hearts Bot
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actionsBot commented Sep 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

babblebey commented Jul 10, 2024• edited by hearts BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes Made

Related Issue

Screencast/Screenshot

Uh oh!

Uh oh!

Uh oh!

Uh oh!

babblebey left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JonasSchubert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

babblebey commented Jul 16, 2024• edited by hearts BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actionsBot commented Sep 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

babblebey commented Jul 10, 2024•
edited by hearts Bot
Loading

babblebey commented Jul 16, 2024•
edited by hearts Bot
Loading