{"id":21734672,"url":"https://github.com/ansys/pydpf-actions","last_synced_at":"2026-05-18T11:38:03.755Z","repository":{"id":39971434,"uuid":"466061742","full_name":"ansys/pydpf-actions","owner":"ansys","description":"This repository hosts DPF workflows.","archived":false,"fork":false,"pushed_at":"2026-02-02T09:44:18.000Z","size":207,"stargazers_count":0,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-21T15:39:45.304Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ansys.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-03-04T09:30:01.000Z","updated_at":"2025-11-24T10:10:47.000Z","dependencies_parsed_at":"2024-01-30T11:29:12.918Z","dependency_job_id":"696b93f6-eb5f-4fd2-b69e-4a869574ab7e","html_url":"https://github.com/ansys/pydpf-actions","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/ansys/pydpf-actions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpydpf-actions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpydpf-actions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpydpf-actions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpydpf-actions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ansys","download_url":"https://codeload.github.com/ansys/pydpf-actions/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansys%2Fpydpf-actions/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33177285,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-18T09:27:30.708Z","status":"ssl_error","status_checked_at":"2026-05-18T09:27:28.300Z","response_time":71,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-26T05:10:05.770Z","updated_at":"2026-05-18T11:38:03.741Z","avatar_url":"https://github.com/ansys.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# pydpf-actions\n\nThis repository hosts github actions specific to DPF. Those actions ca be used in dpf dependent ci/cd\nworkflows for github.\n\n## Hosted actions\n\n### Action install-dpf-server\nThe action  named `install-dpf-server` is hosted in this repository.\n\n#### Use the action\nTo use `install-dpf-server` in a github workflow, add this step:\n```\n- id: install-dpf\n  uses: ansys/pydpf-actions/install-dpf-server@v2.3\n  with:\n    dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}}\n    ANSYS_VERSION : 261\n```\n\n#### Supported options\nLinux and Windows hosted workflows are supported for ANSYS version 2022 R1.\n\n\n### Action install-package\nThe action  named `install-package` is hosted in this repository.\nIt installs the package in the local repository.\nIt is used by the `build_package` and `build_doc` actions.\n\n#### Use the action\nTo use `install-package` in a github workflow, add this step:\n```\n- name: \"Install local package\"\n  uses: ansys/pydpf-actions/install-package@v2.3\n```\n\n#### Supported options\nNo option.\n\n\n### Action build_package\nThe action  named `build_package` is hosted in this repository.\nIt installs and builds the local package, and then uploads the wheel as artifact.\n\n#### Use the action\nTo use `build_package` in a github workflow, add this step:\n```\n- id: build_package\n  uses: ansys/pydpf-actions/build_package@v2.3\n  with:\n    python-version: ********\n    ANSYS_VERSION: ********\n    PACKAGE_NAME: ********\n    MODULE: ********\n    dpf-standalone-TOKEN: ********\n    install_extras: ********\n```\n\n#### Supported options\n\"python-version\" can be any Python version as a string.\n\"ANSYS_VERSION\" can be any version supported by pydpf-actions/install-dpf-server.\n\"PACKAGE_NAME\" is used to name wheels and artifacts.\n\"MODULE\" is used to specify the package module to test \"import\" and retrieve package version.\n\"dpf-standalone-TOKEN\" is the token required by pydpf-actions/install-dpf-server.\n\"install_extras\" is an optional list of extra requirements to be installed for this package.\n\n\n### Action test_package\nThe action  named `test_package` is hosted in this repository.\nIt runs pytest on docstrings and on the tests for the installed local package and then\nuploads the test results as artifacts.\n\n#### Use the action\nTo use `test_package` in a github workflow, add this step:\n```\n- id: test_package\n  uses: ansys/pydpf-actions/test_package@v2.3\n  with:\n    MODULE: ********\n```\n\n#### Supported options\n\"MODULE\" is used to specify the package module to test.\n\n\n### Action release_package\nThe action  named `release_package` is hosted in this repository.\nIt publishes the local DPF package to PyPi along with chosen artifacts.\nCurrently all present \".whl\", \".tar.gz\", \".pdf\" and \".zip\" artifacts \nare released.\n\n#### Use the action\nTo use `release_package` in a github workflow, add this step:\n```\n- name: Release Package\n  uses: ansys/pydpf-actions/release_package@v2.3\n  with:\n    PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}\n```\n\n#### Supported options\n\"PYPI_TOKEN\" is the token for publishing on PyPi.\n\n\n### Action build_doc\nThe action  named `build_doc` is hosted in this repository.\nIt generates the html and pdf documentation using sphinx for the local DPF package.\nIt then zips it and uploads it as artifact.\n\n#### Use the action\nTo use `build_doc` in a github workflow, add this step:\n```\n- id: build_doc\n  uses: ansys/pydpf-actions/build_doc@v2.3\n  with:\n    python-version: \"3.8\"\n    ANSYS_VERSION: 261\n    PACKAGE_NAME: ansys-dpf-post\n    MODULE: post\n    dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}}\n    install_extras: plotting\n  timeout-minutes: 30\n```\n\n#### Supported options\n\"python-version\" can be any Python version as a string.\n\"ANSYS_VERSION\" can be any version supported by pydpf-actions/install-dpf-server.\n\"PACKAGE_NAME\" is used to name wheels and artifacts.\n\"MODULE\" is used to specify the package module to test \"import\" and retrieve package version.\n\"dpf-standalone-TOKEN\" is the token required by pydpf-actions/install-dpf-server.\n\"install_extras\" is an optional list of extra requirements to be installed for this package.\nA timeout is advised to prevent the pipeline from getting stuck.\n\n\n### Action push_doc\nThe action  named `push_doc` is hosted in this repository.\nIt pushes the previously generated documentation to the release branch and the ansys \"DOC-REPO\".\n\n#### Use the action\nTo use `push_doc` in a github workflow, add this step:\n```\n- name: \"Push Documentation\"\n  uses: ansys/pydpf-actions/push_doc@v2.3\n  with:\n    PYANSYS_CI_BOT_TOKEN: ${{secrets.PYANSYS_CI_BOT_TOKEN}}\n    DOC_REPO: DPF-Post-docs\n```\n\n#### Supported options\n\"PYANSYS_CI_BOT_TOKEN\" is the token required to commit on the ansys repo.\n\"DOC_REPO\" is the name of the ansys documentation repository to update.\n\n\n### Action kill-dpf-servers\nThe action  named `kill-dpf-servers` is hosted in this repository.\nIt kills all DPF servers currently running.\nIt is used by the `build_package`, `test_package` and `build_doc` actions.\n\n#### Use the action\nTo use `kill-dpf-servers` in a github workflow, add this step:\n```\n- name: \"Kill all servers\"\n  uses: ansys/pydpf-actions/kill-dpf-servers@v2.3\n```\n\n#### Supported options\nNo option.\n\n\n### Action check-licenses\nThe action  named `check-licenses` is hosted in this repository.\nIt checks licenses of all installed packages in the current environment.\nIt is used by the `build_package` action.\n\n#### Use the action\nTo use `check-licenses` in a github workflow, add this step:\n```\n- name: \"Check licences of packages\"\n  uses: ansys/pydpf-actions/check-licenses@v2.3\n```\n\n#### Supported options\nNo option.\n\n\n## Testing\n\nCi/cd is implemented to test and showcase some actions on linux and windows.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansys%2Fpydpf-actions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fansys%2Fpydpf-actions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansys%2Fpydpf-actions/lists"}