#760-Updating Check Changelog and Update Changelog workflows to make it more robust. #816
Conversation
…rkflows to make them more robust.
There was a problem hiding this comment.
A couple of thoughts - I think best to revert the update to the job id - I have two motivations for reusing the Python script, firstly because it's probably more maintainable for us if this is in Python rather than bash, and secondly, so that we don't break things if we tweak the PR template and forget to update the action.
| @@ -5,27 +5,10 @@ on: | |||
| types: [opened, synchronize, edited, reopened] | |||
|
|
|||
| jobs: | |||
| check-description: | |||
| check-pr-fields: | |||
There was a problem hiding this comment.
I know it's technically no longer correct - but easier to leave this as check-description so that the required check value stays the same in the repository settings.
And technically we are still checking the PR description here, just in more detail than before.
There was a problem hiding this comment.
Ok ....i agree then
|
|
||
| # Default values for each field(According to PR template) | ||
|
|
||
| default_description="Summary of change(s)" |
There was a problem hiding this comment.
I wonder if we could read these values from the Github PR template instead? We could make the Python script used to generate the changelog reusable, and then use it here to parse the Github PR template, and extract the default values from there.
There was a problem hiding this comment.
ok..as you said the python file is more maintainable ,it would make the code more dynamic .But i will need some days to work on it .
There was a problem hiding this comment.
No problem @RONAK-AI647, take your time. We appreciate it.
|
@rtibbles I made a script file where I stored the codes, should that too be turned to a python file. |
@RONAK-AI647 Would you reference for us the file you mean? |
@MisRob |
|
Hi @RONAK-AI647,
I think you mean this file, right? Then, yes, I believe what @rtibbles is asking here is to turn logic there into Python. |
The check changelog section and update changelog section is updated to check every field is validated.
Description
Their is an attempt to make the check changelog workflow more robust so it checks that every field of changelog item exist and they are different from their default values.
Issue addressed
1)check for every field of changelog item.
2)they are different from default values
3)they are properly rendered in the PR description.
Addresses #*PR#
Before/after screenshots
A new file is inserted ,see below.
Changelog
Steps to test
(optional) Implementation notes
At a high level, how did you implement this?
Does this introduce any tech-debt items?
Testing checklist
Reviewer guidance
Comments
It was mentioned in "possible tradeoffs" if we could mention all the logic code in a script file to avoid too much of code in gh workflow, an attempt is made to do so.