Skip to content

maint/deploy pr docs if labelled #1259

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

Draft
waltersma wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

maint/deploy pr docs if labelled #1259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dee8d99
Update ci_cd.yml
waltersma Apr 7, 2026
8036772
chore: adding changelog file 1259.maintenance.md [dependabot-skip]
pyansys-ci-bot Apr 7, 2026
ea86691
Update labels.yml
waltersma Apr 7, 2026
fe2eb54
Update .github/workflows/ci_cd.yml
waltersma Apr 7, 2026
b649655
Update ci_cd.yml
waltersma Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/labels.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
description: Improvements or additions to documentation
color: 0677ba

- name: docs:deploy
description: Deploy PR docs for review as requested
color: 0677ba

- name: enhancement
description: New features or code improvements
color: FFD827
Expand Down
29 changes: 14 additions & 15 deletions .github/workflows/ci_cd.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,21 +134,20 @@ jobs:
PYPRIMEMESH_IMAGE_TAG: ${{ env.DOCKER_IMAGE_TAG }}
ANSYSLMD_LICENSE_FILE: '1055@${{ secrets.LICENSE_SERVER }}'

# Commented out because too many PRs open cause the gh-pages branch to be too large
# doc-deploy-pr:
# name: "Deploy PR documentation"
# runs-on: ubuntu-latest
# needs: docs
# # Run when the PR is closed i.e. when docs job is skipped
# if: always() && (needs.docs.result == 'success' || needs.docs.result == 'skipped')
# steps:
# - uses: ansys/actions/doc-deploy-pr@v10
# with:
# cname: ${{ env.DOCUMENTATION_CNAME }}
# token: ${{ secrets.GITHUB_TOKEN }}
# bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
# bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
# maximum-pr-doc-deployments: 20
doc-deploy-pr:
name: "Deploy PR documentation"
runs-on: ubuntu-latest
needs: docs
# Run when the PR is closed i.e. when docs job is skipped
if: always() && github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'docs:deploy') && (needs.docs.result == 'success' || needs.docs.result == 'skipped')
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

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

This job is gated by the presence of the docs:deploy label, but this workflow’s pull_request trigger types don’t include labeled. As a result, applying the label won’t start a new run, and docs won’t deploy until some other PR event occurs (e.g., a new push or closing the PR). Consider adding labeled to the workflow trigger types so the label takes effect immediately.

Copilot uses AI. Check for mistakes.
steps:
- uses: ansys/actions/doc-deploy-pr@v10
with:
cname: ${{ env.DOCUMENTATION_CNAME }}
token: ${{ secrets.GITHUB_TOKEN }}
bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
maximum-pr-doc-deployments: 20
Comment on lines +137 to +150
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

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

ansys/actions/doc-deploy-pr typically needs to push updates (e.g., to gh-pages) and may also update the PR (comment/status). This job doesn’t declare any permissions:, while other write-capable jobs in this workflow do (e.g., update-changelog). To avoid failures under a read-only default GITHUB_TOKEN, consider adding explicit job permissions (at least contents: write, and pull-requests: write if the action posts back to the PR).

Copilot uses AI. Check for mistakes.

testing:
name: Run Unit Tests
Expand Down
1 change: 1 addition & 0 deletions doc/changelog.d/1259.maintenance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Maint/deploy pr docs if labelled
Copy link

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

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

This changelog fragment’s wording/prefix doesn’t match the style used by other recent fragments in this directory (e.g., "Chore:", "Fix:", "Build(...):"). Consider rephrasing to follow the existing convention so release notes read consistently.

Suggested change
Maint/deploy pr docs if labelled
Chore: deploy PR docs if labelled

Copilot uses AI. Check for mistakes.
Loading