ci: adding pr docs preview action

[germa89]

Description

Deploy PR docs to a temporary directory in github-pages. A message in the PR indicates the link where to check the PR.

Issue linked

NA

Checklist

• I have visited and read Develop PyMAPDL.
• I have tested my changes locally
• I have added necessary documentation or updated existing documentation.
• I have followed the PyMAPDL coding style guidelines.
• I have added appropriate unit tests that also ensure the minimal coverage criteria.
• I have reviewed my changes before submitting this pull request.
• I have linked the issue or issues that are solved to the PR if any.
• I have assigned this PR to myself.
• I have marked this PR as draft if it is not ready to be reviewed yet.
• I have made sure that the title of my PR follows Commit naming conventions (e.g. feat: adding new MAPDL command)

[Copilot]

Pull Request Overview

This PR adds documentation deployment functionality for pull requests by introducing two new GitHub Actions workflows. The implementation allows PR documentation to be deployed to a temporary directory in the github-pages branch, with automatic cleanup when PRs are closed or merged.

• Adds a new workflow for deploying PR documentation that triggers when docs build successfully
• Implements automatic cleanup of PR documentation when PRs are closed or merged
• Extends the main CI workflow to trigger on additional PR events needed for documentation deployment

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
.github/workflows/pr-docs-cleaner.yml	New workflow for cleaning up PR documentation after closure
.github/workflows/ci.yml	Extended PR triggers and added doc deployment job

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[germa89]

I was wondering @moe-ad if having the cleanup in another workflow works with the current action implementation??

[github-actions]

The documentation for this pull request will be available at https://mapdl.docs.pyansys.com/pull/4173. Please allow some time for the documentation to be deployed.

Page not found · GitHub Pages

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.28%. Comparing base (63a2755) to head (47bc089).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4173      +/-   ##
==========================================
- Coverage   91.29%   91.28%   -0.02%     
==========================================
  Files         193      193              
  Lines       15730    15730              
==========================================
- Hits        14361    14359       -2     
- Misses       1369     1371       +2     

🚀 New features to boost your workflow:

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

[germa89]

#PeopleAreOnHolidays #MinorWorks LGTM.

@pyansys-ci-bot LGTM

[pyansys-ci-bot]

✅ Approving this PR because germa89 said so in here 😬

[github-actions]

This PR has been closed. Documentation for this pull request will shortly be removed from its former deployment address.

[germa89]

Action proving the deletion of the deployed docs: https://github.com/ansys/pymapdl/actions/runs/16941487742

Congratulations on this @moe-ad, it works great!!

GitHub

ci: adding pr docs preview action · ansys/pymapdl@47bc089

A Python client library for Ansys MAPDL. Contribute to ansys/pymapdl development by creating an account on GitHub.