Feature/automate changelog note #278

Himani1519 · 2023-08-09T17:54:19Z

VERSION: v2.11.0
CHANGELOG: This action making a CHANGELOG note via special syntax from the GitHub PR commit message, like it could automatically update CHANGELOG.md with the message. First job checks if PR body has changelog note or not if it's not there then it asked them to add it and second job is to check if changelog note has been added in changelog.md file or not.

DivergentEuropeans

This is a great start @Himani1519 but I think there's still a couple edgecases here. In hindsight, automating a changelog is very tricky, so I would have probably argued for a changelog automated "check" instead, and if this check fails, then you fail the PR (and then Git action does the logic there in that PR & sees if it can create its own etc. etc. that gets 👍 'd up by the author) but the check is the most important, not writing/guessing what the changelog is. If the author is making the PR, it's not that much extra work to create a CHANGELOG commit versus writing a little "Changelog: xxxx" thing in the PR description. Authors don't create those because they forget and aren't reminded, not lazy. But either way, anyway now that you've started it, this will be even better! BUT it should do that initial check first

DivergentEuropeans · 2023-08-21T03:29:24Z

.github/workflows/build-core.yml

-        id: set-flag
+          PR_DESCRIPTION="${{ github.event.pull_request.body }}"
+
+          # Check if "changelog:" exists in PR description


Is that actually true? Will "changelog:" work? Or is it case sensitive?

If it is, then next line should be updated

DivergentEuropeans · 2023-08-21T03:36:44Z

.github/workflows/build-core.yml

-      - name: Check if CHANGELOG is Updated and Abort if not updated
-        if: steps.set-flag.outputs.file-flag != 'true'
+          if ! grep -Fq "${{ steps.extract-changelog.outputs.changelog }}" CHANGELOG.md; then
+            LINE_NUMBER=$(awk '/^##/{print NR; exit}' CHANGELOG.md)


So looks like LINE_NUMBER will be set to the line number of the first occurrence of a line starting with ## in CHANGELOG.md
which looks good 👍

However, this will fail when the first changelog to be added is a changelog for a new Zowe version. And I have no idea how you'd automate against that, is there something in your Github action that can tell you what Zowe version it is? This is good for now, but here's what could happen:

Zowe PR author forgets changelog in a PR for new Zowe release

Automation adds changelog

Changelog gets committed into CHANGELOG.md into wrong Zowe release section, PR author doesn't know.

You need some way for the PR author to sign off on this. Is there a GitHub action thing where PR is blocked w/o changelog as to enforce it, but the action itself needs to be check somehow by author? Even as something as, if they are responsible for clicking the button, and after a message pops up somewhere that says "Changelog has been added automatically. I tried my best, but check if it's the correct Zowe version!"

Another issue:
Forgive me if I'm wrong, my bash is poor. I don't this checks if a CHANGELOG update already exists? ie a user can have a CHANGELOG update in their commits, but this isn't checked for

This could be done via Git action by checking if a commit in the PR contains the words "CHANGELOG"/"changelog"

DivergentEuropeans · 2023-08-21T03:58:33Z

.github/workflows/build-core.yml

-        if: steps.set-flag.outputs.file-flag != 'true'
+          if ! grep -Fq "${{ steps.extract-changelog.outputs.changelog }}" CHANGELOG.md; then
+            LINE_NUMBER=$(awk '/^##/{print NR; exit}' CHANGELOG.md)
+            sed -i "${LINE_NUMBER} a- ${{ steps.extract-changelog.outputs.changelog }} . (#${{ github.event.pull_request.number }})" CHANGELOG.md


remove the extra period here because (personal opinion)

changelog.md file or not. . (#278)
looks worse than
changelog.md file or not (#278) or changelog.md file or not. (#278)

Sure will update that

DivergentEuropeans · 2023-08-22T08:45:24Z

.github/workflows/build-core.yml

+            echo "::set-output name=version::$VERSION"
+          else
+            echo -e "No changelog and version information found in PR description please add them.\n Expected Format:\n VERSION:vX.XX.X\n CHANGELOG:This is changelog note.\n
+            To re-run the action, just pushed/commit the changes along with PR description, it will automatically triggered by sync."


To re-run the action, just make a push or commit after updating the PR description or updating the changelog via a manual file changing commit.

DivergentEuropeans · 2023-08-22T08:46:04Z

CHANGELOG.md

@@ -3,6 +3,7 @@
 All notable changes to the Zlux App Server package will be documented in this file.

 ## v2.11.0
+- This action making a CHANGELOG note via special syntax from the GitHub PR commit message, like it could automatically update CHANGELOG.md with the message. First job checks if PR body has changelog note or not if it's not there then it asked them to add it and second job is to check if changelog note has been added in changelog.md file or not. . (#278)


*. .
isn't right

Signed-off-by: Himani1519 <[email protected]>

1000TurquoisePogs

After latest changes, looks good now and you can see my tests in
1000TurquoisePogs#7

it does have a failure mode as seen in
1000TurquoisePogs#6
i'm looking forward to that being addressed in a future pr.

Signed-off-by: Himani1519 <[email protected]>

Himani1519 · 2023-09-05T14:53:39Z

This is a great start @Himani1519 but I think there's still a couple edgecases here. In hindsight, automating a changelog is very tricky, so I would have probably argued for a changelog automated "check" instead, and if this check fails, then you fail the PR (and then Git action does the logic there in that PR & sees if it can create its own etc. etc. that gets 👍 'd up by the author) but the check is the most important, not writing/guessing what the changelog is. If the author is making the PR, it's not that much extra work to create a CHANGELOG commit versus writing a little "Changelog: xxxx" thing in the PR description. Authors don't create those because they forget and aren't reminded, not lazy. But either way, anyway now that you've started it, this will be even better! BUT it should do that initial check first

Fixed

Himani1519 · 2023-09-05T14:54:18Z

This is a great start @Himani1519 but I think there's still a couple edgecases here. In hindsight, automating a changelog is very tricky, so I would have probably argued for a changelog automated "check" instead, and if this check fails, then you fail the PR (and then Git action does the logic there in that PR & sees if it can create its own etc. etc. that gets 👍 'd up by the author) but the check is the most important, not writing/guessing what the changelog is. If the author is making the PR, it's not that much extra work to create a CHANGELOG commit versus writing a little "Changelog: xxxx" thing in the PR description. Authors don't create those because they forget and aren't reminded, not lazy. But either way, anyway now that you've started it, this will be even better! BUT it should do that initial check first

Fixed

Signed-off-by: Himani1519 <[email protected]>

stale

pull-request-size bot added the size/M label Aug 9, 2023

github-actions bot pushed a commit that referenced this pull request Aug 17, 2023

Update changelog with PR #278 description

d9ba624

DivergentEuropeans previously requested changes Aug 21, 2023

View reviewed changes

DivergentEuropeans reviewed Aug 21, 2023

View reviewed changes

pull-request-size bot added size/L and removed size/M labels Aug 21, 2023

DivergentEuropeans reviewed Aug 22, 2023

View reviewed changes

sagar-1310 and others added 22 commits August 29, 2023 20:50

Added Changelog file check

21e66a6

Signed-off-by: Himani1519 <[email protected]>

Updated the code as per the suggestions

62e9512

Signed-off-by: Himani1519 <[email protected]>

Updated code to Build to not fail even if Changelog not udpated

405c5a4

Signed-off-by: Himani1519 <[email protected]>

Removed temporary dir after Check changelog

ac727bb

Signed-off-by: Himani1519 <[email protected]>

Updated Changelog to original

5a80c83

Signed-off-by: Himani1519 <[email protected]>

MVD-5924

21d4b8b

Signed-off-by: Himani1519 <[email protected]>

MVD-5924

a7b1389

Signed-off-by: Himani1519 <[email protected]>

MVD-5924

f93a33c

Signed-off-by: Himani1519 <[email protected]>

MVD-5924

57bf3ab

Signed-off-by: Himani1519 <[email protected]>

Automate changelog note

06d867a

Signed-off-by: Himani1519 <[email protected]>

fixed syntax error

b81d55c

Signed-off-by: Himani1519 <[email protected]>

To test

82447e6

Signed-off-by: Himani1519 <[email protected]>

Add more checks

b4f12c0

Signed-off-by: Himani1519 <[email protected]>

Update changelog with PR #278 description

6b2850d

Signed-off-by: Himani1519 <[email protected]>

Add more checks

93ed4e7

Signed-off-by: Himani1519 <[email protected]>

update msg

3cc7179

Signed-off-by: Himani1519 <[email protected]>

update msg

016abb6

Signed-off-by: Himani1519 <[email protected]>

update msg

7d7b0b6

Signed-off-by: Himani1519 <[email protected]>

Minor change

2e41a8b

Signed-off-by: Himani1519 <[email protected]>

Minor changes

9a0af94

Signed-off-by: Himani1519 <[email protected]>

minor change

33ecca8

Signed-off-by: Himani1519 <[email protected]>

update changelog

3ac948e

Signed-off-by: Himani1519 <[email protected]>

Himani1519 force-pushed the feature/Automate_changelog_note branch from 51328e5 to 3ac948e Compare August 29, 2023 15:21

1000TurquoisePogs approved these changes Sep 5, 2023

View reviewed changes

Resolve conflicts

46368ee

Signed-off-by: Himani1519 <[email protected]>

Himani1519 closed this Sep 5, 2023

Himani1519 reopened this Sep 5, 2023

update changelog.md

da005e3

Signed-off-by: Himani1519 <[email protected]>

1000TurquoisePogs requested a review from DivergentEuropeans September 5, 2023 17:42

1000TurquoisePogs merged commit 5fdd60c into v2.x/staging Sep 5, 2023
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/automate changelog note #278

Feature/automate changelog note #278

Himani1519 commented Aug 9, 2023 •

edited

Loading

DivergentEuropeans left a comment •

edited

Loading

DivergentEuropeans Aug 21, 2023

DivergentEuropeans Aug 21, 2023

DivergentEuropeans Aug 21, 2023

DivergentEuropeans Aug 21, 2023

DivergentEuropeans Aug 21, 2023

DivergentEuropeans Aug 21, 2023

Himani1519 Aug 21, 2023

DivergentEuropeans Aug 22, 2023

DivergentEuropeans Aug 22, 2023

1000TurquoisePogs left a comment

Himani1519 commented Sep 5, 2023

Himani1519 commented Sep 5, 2023

Feature/automate changelog note #278

Feature/automate changelog note #278

Conversation

Himani1519 commented Aug 9, 2023 • edited Loading

DivergentEuropeans left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1000TurquoisePogs left a comment

Choose a reason for hiding this comment

Himani1519 commented Sep 5, 2023

Himani1519 commented Sep 5, 2023

Himani1519 commented Aug 9, 2023 •

edited

Loading

DivergentEuropeans left a comment •

edited

Loading