Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HPCC-32688 Add JirabotMerge Github Action #19135

Merged
merged 1 commit into from
Oct 17, 2024
Merged

HPCC-32688 Add JirabotMerge Github Action #19135

merged 1 commit into from
Oct 17, 2024

Conversation

jpmcmu
Copy link
Contributor

@jpmcmu jpmcmu commented Sep 20, 2024

  • Added a Github action to update Jira issues upon PR merger

Signed-off-by: James McMullan James.McMullan@lexisnexis.com

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@github-actions GitHub Actions
Copy link

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-32688

Jirabot Action Result:
Workflow Transition To: Merge Pending
Additional PR: #19135

@jpmcmu
Copy link
Contributor Author

jpmcmu commented Sep 20, 2024 •
edited
Loading

Notes on merge script: The script uses the target branch and the git tags to determine the correct fix versions to add to the Jira issue. The logic for this is as follow:

  • If merging into master, find latest tag version and increment to next major. IE: merging while 9.8.X is the latest release will result in a 9.10.0 fix version
  • If merging into candidate-9.X, find the latest point in that minor, increment it and add to fix versions, increment minor and repeat process until we are at latest minor

Here is an example run from my fork merging into master. It added 9.10.0 to the Jira issue: https://github.com/jpmcmu/HPCC-Platform/actions/runs/10951362829

ghalliday
ghalliday approved these changes Sep 23, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good afaics. I have added the relevant variable.

GordonSmith
GordonSmith approved these changes Sep 26, 2024
View reviewed changes
Copy link
Member

@GordonSmith GordonSmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - I didn't review the python code...

.github/workflows/jirabot-merge.yml Outdated
python -m pip install --upgrade atlassian-python-api
python -m pip install --upgrade jira
- name: "Checkout"
uses: actions/checkout@v2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be version 4

.github/workflows/jirabot-merge.yml Outdated
echo "Pull Request URL: ${{ github.event.pull_request.html_url }}"
echo "Comments URL: ${{ github.event.pull_request.comments_url }}"
echo "Branch Name: ${{ github.ref_name }}"
- uses: "actions/setup-python@v2"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be version 5?

.github/workflows/jirabot-merge.yml Outdated
print('Unable to find Jira issue name in title')

print(result)
shell: python
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: Move shell to above the run for consistency with other actions

@GordonSmith GordonSmith self-requested a review September 26, 2024 12:40
GordonSmith
GordonSmith requested changes Sep 26, 2024
View reviewed changes
Copy link
Member

@GordonSmith GordonSmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just minor changes

@jpmcmu
Copy link
Contributor Author

jpmcmu commented Oct 1, 2024

@GordonSmith thanks for the review, made those changes

@ghalliday
Copy link
Member

@jpmcmu please look at the security warning - which does indicate a real vulnerability

@jpmcmu
HPCC-32688 Add JirabotMerge Github Action
0435e0a 
- Added a Github action to update Jira issues upon PR merger

Signed-off-by: James McMullan James.McMullan@lexisnexis.com
@jpmcmu
Copy link
Contributor Author

jpmcmu commented Oct 4, 2024

@ghalliday Addressed the security issue and squashed

@rpastrana rpastrana requested a review from GordonSmith October 8, 2024 20:02
@ghalliday
Copy link
Member

@jpmcmu can you explain how your change avoids the security problem? Will it not sill be possible for someone to insert arbitrary text into a title, which will then be echoed? I haven't understood why putting it in an environment variable first helps (other than confusing the checking tool)

@jpmcmu
Copy link
Contributor Author

jpmcmu commented Oct 16, 2024

@ghalliday Good question, I followed Github's recommendations on how to address the issue, but should have added a comment about why the changes addressed the security issue. (GitHubs: recommendation: https://github.com/hpcc-systems/HPCC-Platform/security/code-scanning/278)

Bash apparently treats the environment variable as a single string which is escaped and prevents injection.

@ghalliday ghalliday merged commit 986b454 into hpcc-systems:candidate-9.2.x Oct 17, 2024
50 of 51 checks passed
@github-actions GitHub Actions
Copy link

Jirabot Action Result:
Added fix version: 9.2.132
Added fix version: 9.4.106
Added fix version: 9.6.58
Added fix version: 9.8.32

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GordonSmith GordonSmith GordonSmith approved these changes

@ghalliday ghalliday ghalliday approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jpmcmu @ghalliday @GordonSmith