fix: migrator syntax problem #4031

germa89 · 2025-06-23T09:37:54Z

Description

Fix markdown code outside js literal string. Also small improvements.

More improvements fix should arise with usage.

Issue linked

Checklist

Summary by Sourcery

Fix syntax issues and enhance robustness in the migrator GitHub Actions workflow

Bug Fixes:

Fix quoting of the github-token input and correct variable references (e.g., comment_id)
Correct destructuring of pull request data from the GitHub API

Enhancements:

Add fallback git fetch-and-push logic for failed pushes
Switch from octokit to the github client for assigning PR assignees
Tidy PR body string formatting in the workflow script
Introduce comment_id environment variable for consistency

CI:

Prevent failure comment on retry when triggered by workflow_dispatch events

ansys-reviewer-bot · 2025-06-23T09:37:57Z

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

sourcery-ai · 2025-06-23T09:37:58Z

Reviewer's Guide

This PR refactors the GitHub Actions migrator workflow to correct JS template syntax, bolster git push reliability, standardize inputs, introduce missing variables, streamline REST API calls, and refine conditional logic for comment creation.

File-Level Changes

Change	Details	Files
Enhanced git push retry logic	Chained git fetch with retry on push failure Retained force-with-lease in all retry attempts	`.github/workflows/migrator.yml`
Standardized GitHub token input	Removed extra quotes around the github-token input	`.github/workflows/migrator.yml`
Introduced comment_id variable	Declared const comment_id from env Replaced direct env reference with the variable	`.github/workflows/migrator.yml`
Streamlined REST API calls	Destructured pulls.get response as data: originalPR Added const for newPrData when creating PR Switched from octokit.request to github.request for assignees	`.github/workflows/migrator.yml`
Fixed PR body template formatting	Adjusted backticks and commas to properly embed markdown Inserted a blank line after the 'Closes' line	`.github/workflows/migrator.yml`
Refined failure comment condition	Added github.event_name != 'workflow_dispatch' to the if clause Maintained single-run failure comment guard	`.github/workflows/migrator.yml`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @germa89 - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

codecov · 2025-06-23T09:57:20Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.12%. Comparing base (27d26c4) to head (0c831b5).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4031      +/-   ##
==========================================
- Coverage   89.17%   89.12%   -0.05%     
==========================================
  Files         187      187              
  Lines       14970    14970              
==========================================
- Hits        13349    13342       -7     
- Misses       1621     1628       +7

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…out command

…s/pymapdl into fix/migrator-syntax-problem

germa89 · 2025-06-23T11:48:09Z

It seems I did a total mess up in #3973. I am fixing that in here.

germa89 · 2025-06-25T10:22:35Z

Pinging @RobPasMue @jorgepiloto @MaxJPRey for review/awareness.

RobPasMue

Small comments, LGTM!

RobPasMue · 2025-06-25T10:28:13Z

.github/workflows/migrator.yml

+            You can clone this branch in a new repository by doing:
+
+            ~~~terminal
+            git clone -b ${prHeadBranch} --single-branch https://github.com/ansys/pymapdl.git


Can't you programatically get the repository from the PR context? Just wondering

Yes, I can. I believe github.repository is the way.

RobPasMue · 2025-06-25T10:28:21Z

.github/workflows/migrator.yml

+            If you have [GitHub CLI](https://cli.github.com/) installed, you can also use the following command to check out the pull request:
+
+            ~~~terminal
+            gh pr checkout https://github.com/ansys/pymapdl/pull/${prNumber}


Sure!

I guess want me to prepare the workflow to be less PyMAPDL-dependent, for the future migration to ansys/actions if that ever happens.

You got my point without even saying it 😄

Very well then. I will reping you when ready :)

Thanks @germa89 - much appreciated. Getting this as agnostic as possible from the repo will allow you to migrate it seamlessly. This is honestly a great feature.

Good approach. It will be helpful for all of us. Thanks @germa89

germa89 added 6 commits June 23, 2025 10:46

refactor: using js code to get envvar. Fix missing variable definition.

d7082f1

fix: code outside js string

9463d78

fix: destructure response to retrieve original PR details correctly

10de286

fix: update request method to use github object for assigning PRs

78d4f55

fix: avoid failure reporting when using workflow dispatch.

e882869

fix: enhance push command to handle fetch failure gracefully

ae79cf5

germa89 requested a review from a team as a code owner June 23, 2025 09:37

germa89 requested review from clatapie and pyansys-ci-bot June 23, 2025 09:37

germa89 self-assigned this Jun 23, 2025

github-actions bot added CI/CD Related with CICD, Github Actions, etc maintenance General maintenance of the repo (libraries, cicd, etc) bug Issue, problem or error in PyMAPDL labels Jun 23, 2025

sourcery-ai bot reviewed Jun 23, 2025

View reviewed changes

chore: adding changelog file 4031.fixed.md [dependabot-skip]

7c35f90

germa89 added 2 commits June 23, 2025 13:38

fix: enhance migration comment with cloning instructions and PR check…

44e7eee

…out command

Merge branch 'fix/migrator-syntax-problem' of https://github.com/ansy…

db5fea2

…s/pymapdl into fix/migrator-syntax-problem

germa89 requested a review from RobPasMue June 23, 2025 11:46

fix: update migration completion message format for better visibility

0c831b5

RobPasMue approved these changes Jun 25, 2025

View reviewed changes

MaxJPRey approved these changes Jun 25, 2025

View reviewed changes

fix: migrator syntax problem #4031

Are you sure you want to change the base?

fix: migrator syntax problem #4031

Conversation

germa89 commented Jun 23, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issue linked

Checklist

Summary by Sourcery

Uh oh!

ansys-reviewer-bot bot commented Jun 23, 2025

Uh oh!

sourcery-ai bot commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

germa89 commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

germa89 commented Jun 25, 2025

Uh oh!

RobPasMue left a comment

Choose a reason for hiding this comment

Uh oh!

RobPasMue Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

germa89 Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

RobPasMue Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

germa89 Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

RobPasMue Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

germa89 Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RobPasMue Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

MaxJPRey Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

germa89 commented Jun 23, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jun 23, 2025 •

edited

Loading

codecov bot commented Jun 23, 2025 •

edited

Loading

germa89 commented Jun 23, 2025 •

edited

Loading

germa89 Jun 25, 2025 •

edited

Loading