Enhance sdk-changelog commands #4040

GuyAfik · 2024-02-12T14:23:19Z

Related Issues

related: https://jira-dc.paloaltonetworks.com/browse/CIAC-9581

Description

Added support for the sdk-changelog --init command automatically detect the pull request number.
Add PR comment with the changelog markdown on every change.

Tests:

test when changelog was not changed or added between two last commits (no comment on the PR: 8acdd4c)
test when changelog has been changed between two last commits: (there is a comment on the PR: 57396d6)
test when changelog does not exist at all (should fail on validate) - 17be450
test when changelog was added between two last commits - should comment on the PR (c9a363a)

coveralls · 2024-02-12T16:30:14Z

Pull Request Test Coverage Report for Build 6aaf28fc-51d6-44ae-849e-9eb74299a1dc

Details

28 of 45 (62.22%) changed or added relevant lines in 2 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.007%) to 80.942%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
demisto_sdk/commands/common/git_util.py	7	8	87.5%
demisto_sdk/scripts/changelog/changelog.py	21	37	56.76%

Totals
Change from base Build 85e84e51-453b-4b0d-8e44-7af2166e3a6e:	-0.007%
Covered Lines:	36607
Relevant Lines:	45226

💛 - Coveralls

github-actions · 2024-02-12T19:34:30Z

Your changelog in markdown :)
:None

github-actions · 2024-02-12T20:05:26Z

Changelog(s) in markdown:
just a test for markdown

github-actions · 2024-02-12T20:30:48Z

Changelog(s) in markdown:

just a test for markdown, its a new feature for argument test #4040

github-actions · 2024-02-12T21:24:06Z

Changelog(s) in markdown:

just a test for markdown, its a new feature for argument test #4040
just a test for markdown-2, its a new feature for argument test #4040

github-actions · 2024-02-13T12:33:04Z

Changelog(s) in markdown:

Added a new step in the validate-changelog to comment the changelog description in PR comments. #4040
Added support to query the pull request number automaticlly when running sdk-changelog --init command. #4040

github-actions · 2024-02-13T12:47:14Z

Changelog(s) in markdown:

Added a new step in the validate-changelog to comment the changelog description in PR comments. #4040
Added support to query the pull request number automaticlly when running sdk-changelog --init command.. #4040

github-actions · 2024-02-13T12:49:35Z

Changelog(s) in markdown:

Added a new step in the validate-changelog to comment the changelog description in PR comments. #4040
Added support to query the pull request number automaticlly when running sdk-changelog --init command. #4040

dorschw · 2024-02-13T13:39:24Z

.github/workflows/on-push.yml

@@ -36,6 +36,14 @@ jobs:
        run: |
          echo "Validating changelog for PR: $PR_NUMBER with Name: $PR_TITLE"
          poetry run python ./Utils/github_workflow_scripts/changelog_validation_scripts/validate_changelog.py -n "$PR_NUMBER" -t "$PR_TITLE"
+      - name: Comment Changelog In PR Description


Consider making this run only if the changelog validation passed (needs: validate-changelog) instead of continue-on-error

wdym? it already runs only if validate was successful. (its like the behaivor you described, needs: validate-changelog)
I didn't see a reason to fail the whole job in case the comment step didn't work, that's why i use continue_on_error only on the last step.

Utils/github_workflow_scripts/changelog_comment_scripts/comment_changelog.py

demisto_sdk/commands/common/git_util.py

ilaner

nice job!

…sdk_changelog_init

github-actions · 2024-02-14T08:13:30Z

Changelog(s) in markdown:

Added a new step in the validate-changelog to comment the changelog description in PR comments. #4040
Added support to query the pull request number automatically when running sdk-changelog --init command. #4040

GuyAfik added 10 commits February 12, 2024 15:37

add script to comment to changelog

0252abb

call script on-push

3ce6c07

call pr

07473bf

fix issues

84ec72e

poetry github

daed917

add changelog

7f8c267

fix bug

ad8ef8e

test

4d7b755

test

891c588

fix bug

339adf2

GuyAfik added 10 commits February 12, 2024 19:24

try to fix 404

d476e77

test

6bfa676

remove env

26083df

echo

311c67f

echo

21be113

test

0e0a07e

prints

d22a74c

int type

4f3effb

create issue comment

d709b35

fix

3b0532c

GuyAfik added 3 commits February 12, 2024 21:49

update message

f3ec472

test

34a3d74

fix

45507d5

test

95a3169

fetch before fetching commit

8df7448

GuyAfik added 2 commits February 13, 2024 14:06

get pulls

7c8bbd0

handle better exceptions

9002002

GuyAfik changed the title ~~Enhance sdk changelog init~~ Enhance sdk-changelog commands Feb 13, 2024

GuyAfik added 2 commits February 13, 2024 14:28

fix message

d45ace7

changelog

7b8279f

GuyAfik marked this pull request as ready for review February 13, 2024 12:36

GuyAfik added 2 commits February 13, 2024 14:43

remove ssl and make const

115eeec

change the changelog

8493c57

remove dot

9296535

dorschw reviewed Feb 13, 2024

View reviewed changes

cr fixes

dd4d404

GuyAfik requested a review from dorschw February 13, 2024 16:02

code formatting

98175c3

ilaner approved these changes Feb 13, 2024

View reviewed changes

GuyAfik added 6 commits February 13, 2024 19:41

add unit-tests for comment method

9ad2350

fix comment_changelog_on_pr

538b787

pre-commit

d4a5bb8

Merge branch 'master' of github.com:demisto/demisto-sdk into enhance_…

cbff16e

…sdk_changelog_init

fix tests

285b41d

last changes

345854c

GuyAfik added 2 commits February 14, 2024 10:14

fix

66c0a64

pre-commit

d7504ac

GuyAfik merged commit 116f567 into master Feb 14, 2024
33 checks passed

GuyAfik deleted the enhance_sdk_changelog_init branch February 14, 2024 09:16

adi88d mentioned this pull request Feb 25, 2024

Demisto-sdk release 1.27.0 #4083

Merged

content-bot mentioned this pull request Feb 25, 2024

demisto-sdk-release 1.27.0 demisto/content#33095

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance sdk-changelog commands #4040

Enhance sdk-changelog commands #4040

GuyAfik commented Feb 12, 2024 •

edited by dorschw

Loading

coveralls commented Feb 12, 2024 •

edited

Loading

github-actions bot commented Feb 12, 2024

github-actions bot commented Feb 12, 2024

github-actions bot commented Feb 12, 2024

github-actions bot commented Feb 12, 2024

github-actions bot commented Feb 13, 2024

github-actions bot commented Feb 13, 2024

github-actions bot commented Feb 13, 2024

dorschw Feb 13, 2024

GuyAfik Feb 13, 2024 •

edited

Loading

ilaner left a comment

github-actions bot commented Feb 14, 2024

Enhance sdk-changelog commands #4040

Enhance sdk-changelog commands #4040

Conversation

GuyAfik commented Feb 12, 2024 • edited by dorschw Loading

Related Issues

Description

coveralls commented Feb 12, 2024 • edited Loading

Pull Request Test Coverage Report for Build 6aaf28fc-51d6-44ae-849e-9eb74299a1dc

Details

💛 - Coveralls

github-actions bot commented Feb 12, 2024

github-actions bot commented Feb 12, 2024

github-actions bot commented Feb 12, 2024

github-actions bot commented Feb 12, 2024

github-actions bot commented Feb 13, 2024

github-actions bot commented Feb 13, 2024

github-actions bot commented Feb 13, 2024

dorschw Feb 13, 2024

Choose a reason for hiding this comment

GuyAfik Feb 13, 2024 • edited Loading

Choose a reason for hiding this comment

ilaner left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 14, 2024

GuyAfik commented Feb 12, 2024 •

edited by dorschw

Loading

coveralls commented Feb 12, 2024 •

edited

Loading

GuyAfik Feb 13, 2024 •

edited

Loading