Skip to content

build: Update release doc build. #584

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

Merged
merged 1 commit into from
Sep 19, 2025
Merged

build: Update release doc build. #584

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 22 additions & 11 deletions .github/workflows/ci_cd.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,16 @@
env:
DOC_DEPLOYMENT_IMAGE_TAG: v25.1.0
DOCUMENTATION_CNAME: "visualization.fluent.docs.pyansys.com"
XDG_RUNTIME_DIR: /tmp/runtime-${{ github.run_id }}

steps:
- uses: actions/checkout@v5

- name: Create XDG_RUNTIME_DIR
run: |
mkdir -p "$XDG_RUNTIME_DIR"
chmod 700 "$XDG_RUNTIME_DIR"
- name: Set up Python
uses: actions/setup-python@v5
with:
Expand Down Expand Up @@ -166,23 +172,28 @@
uses: actions/upload-artifact@v4
with:
name: HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
path: doc/_build/html
path: HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}.zip
retention-days: 7

- name: Deploy
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && !contains(github.ref, 'dev')
uses: ansys/actions/doc-deploy-stable@v10
- name: Remove all docker images
if: always()
run: make docker-clean-images

deploy-docs-release:
name: "Upload release documentation"
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
runs-on: ubuntu-latest
needs: [ docs ]
steps:
- name: "Deploy the stable documentation"
uses: ansys/actions/doc-deploy-stable@v10.1.0

Check warning

Code scanning / CodeQL

Unpinned tag for a non-immutable Action in workflow Medium

Unpinned 3rd party Action 'GitHub CI' step
Uses Step
Loading
uses 'ansys/actions/doc-deploy-stable' with ref 'v10.1.0', not a pinned commit hash
with:
doc-artifact-name: 'HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}'
doc-artifact-name: HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
cname: ${{ env.DOCUMENTATION_CNAME }}
token: ${{ secrets.GITHUB_TOKEN }}
bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}

- name: Remove all docker images
if: always()
run: make docker-clean-images

build:

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {}
name: Build library
needs: [tests, docs]
Expand Down Expand Up @@ -232,7 +243,7 @@

- name: Upload to Private PyPi
run: |
pip install twine
pip install 'twine<6.2.0'
python -m twine upload --skip-existing ./**/*.whl
python -m twine upload --skip-existing ./**/*.tar.gz
env:
Expand All @@ -242,7 +253,7 @@

- name: Upload to Public PyPi
run: |
pip install twine
pip install 'twine<6.2.0'
twine upload --skip-existing ./**/*.whl
python -m twine upload --skip-existing ./**/*.tar.gz
env:
Expand Down
Loading