Skip to content

Conversation

@germa89
Copy link
Collaborator

@germa89 germa89 commented Jul 22, 2025

Description

Update docker image tag in documentation build workflow.

Issue linked

NA

Checklist

Summary by Sourcery

Update documentation build workflow to use MAPDL v25.2-ubuntu-cicd image and streamline DPF server activation

CI:

  • Switch MAPDL_IMAGE_VERSION_DOCS_BUILD to v25.2-ubuntu-cicd
  • Remove the DPF_DOCKER_IMAGE variable and the dedicated DPF server activation step
  • Introduce RUN_DPF_SERVER flag and DPF_PORT_INTERNAL environment variable in the workflow run step

Copilot AI review requested due to automatic review settings July 22, 2025 08:57
@germa89 germa89 requested a review from a team as a code owner July 22, 2025 08:57
@ansys-reviewer-bot
Copy link
Contributor

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

@ansys-reviewer-bot review

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jul 22, 2025

Reviewer's Guide

This PR bumps the MAPDL image version used in the documentation CI workflow and refactors the DPF server activation by removing the standalone activation step, updating environment variables, and enabling inline server startup.

File-Level Changes

Change Details Files
Update MAPDL Docker image tag for documentation build
  • Changed MAPDL_IMAGE_VERSION_DOCS_BUILD from v24.2-ubuntu-student to v25.2-ubuntu-cicd
.github/workflows/doc-build.yml
Refactor DPF server activation in CI workflow
  • Removed DPF_DOCKER_IMAGE environment variable assignment
  • Deleted the separate 'DPF server activation' step
  • Added DPF_PORT and DPF_PORT_INTERNAL environment variables
  • Enabled inline DPF startup by setting RUN_DPF_SERVER=true
.github/workflows/doc-build.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

@germa89 germa89 self-assigned this Jul 22, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation build workflow to use a newer MAPDL image version and streamlines the DPF server setup process. The changes consolidate DPF server configuration into the main MAPDL startup script instead of using a separate activation step.

  • Updates MAPDL image version from v24.2-ubuntu-student to v25.2-ubuntu-cicd
  • Removes dedicated DPF server activation step and integrates DPF configuration into the main MAPDL startup process
  • Adds DPF port configuration variables to support the integrated setup

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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.

@github-actions 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 Jul 22, 2025
@codecov
Copy link

codecov bot commented Jul 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.32%. Comparing base (86fa0c0) to head (ab58ff6).
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4118      +/-   ##
==========================================
+ Coverage   91.30%   91.32%   +0.01%     
==========================================
  Files         189      189              
  Lines       15649    15650       +1     
==========================================
+ Hits        14289    14292       +3     
+ Misses       1360     1358       -2     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89
Copy link
Collaborator Author

germa89 commented Jul 22, 2025

@pyansys-ci-bot LGTM.

@germa89 germa89 enabled auto-merge (squash) July 22, 2025 09:43
Copy link
Contributor

@pyansys-ci-bot pyansys-ci-bot left a comment

Choose a reason for hiding this comment

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

✅ Approving this PR because germa89 said so in here 😬

LGTM

@germa89 germa89 merged commit 502a5e2 into main Jul 22, 2025
48 checks passed
@germa89 germa89 deleted the ci/update-doc-build-image branch July 22, 2025 09:43
germa89 added a commit that referenced this pull request Jul 31, 2025
…tion step in documentation build workflow (#4118)"

This reverts commit 502a5e2.
germa89 added a commit that referenced this pull request Jul 31, 2025
…tion step in documentation build workflow (#4118)" (#4132)

* revert: "fix: update MAPDL image version and remove DPF server activation step in documentation build workflow (#4118)"

This reverts commit 502a5e2.

* chore: adding changelog file 4132.miscellaneous.md [dependabot-skip]

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Issue, problem or error in PyMAPDL CI/CD Related with CICD, Github Actions, etc maintenance General maintenance of the repo (libraries, cicd, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants