Skip to content
Open
Changes from all commits
Commits
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
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,12 @@ on: [push,pull_request]

jobs:
cxx-build-workflow:
uses: InsightSoftwareConsortium/ITKRemoteModuleBuildTestPackageAction/.github/workflows/build-test-cxx.yml@d4a5ce4f219b66b78269a15392e15c95f90e7e00
uses: InsightSoftwareConsortium/ITKRemoteModuleBuildTestPackageAction/.github/workflows/build-test-cxx.yml@main
with:
itk-cmake-options: '-DITK_BUILD_DEFAULT_MODULES:BOOL=OFF -DITKGroup_Core:BOOL=ON'

python-build-workflow:
uses: InsightSoftwareConsortium/ITKRemoteModuleBuildTestPackageAction/.github/workflows/build-test-package-python.yml@d4a5ce4f219b66b78269a15392e15c95f90e7e00
uses: InsightSoftwareConsortium/ITKRemoteModuleBuildTestPackageAction/.github/workflows/build-test-package-python.yml@main
secrets:
pypi_password: ${{ secrets.pypi_password }}
```
Expand All @@ -117,7 +117,7 @@ The top-level jobs used to organize the run. Reusable workflows may provide mult

```yaml
cxx-build-workflow:
uses: InsightSoftwareConsortium/ITKRemoteModuleBuildTestPackageAction/.github/workflows/build-test-cxx.yml@d4a5ce4f219b66b78269a15392e15c95f90e7e00
uses: InsightSoftwareConsortium/ITKRemoteModuleBuildTestPackageAction/.github/workflows/build-test-cxx.yml@main
```
Tells GHA to fetch and run the `build-test-cxx.yml` workflow.
A commit hash or tagged version may be provided.
Expand All @@ -132,7 +132,7 @@ certain modules are built before the external module itself is subsequently buil

```yaml
python-build-workflow:
uses: InsightSoftwareConsortium/ITKRemoteModuleBuildTestPackageAction/.github/workflows/build-test-package-python.yml@d4a5ce4f219b66b78269a15392e15c95f90e7e00
uses: InsightSoftwareConsortium/ITKRemoteModuleBuildTestPackageAction/.github/workflows/build-test-package-python.yml@main
```
Tells GHA to fetch and run the `build-test-package-python.yml` workflow.
A commit hash or tagged version may be provided.
Expand Down Expand Up @@ -161,7 +161,7 @@ to direct workflow execution.

```yaml
with:
itk-git-tag: 'v5.3.0'
itk-git-tag: 'v5.4.5'
```

- `itk-cmake-options`: CMake configuration parameters for building ITK as a prerequisite.
Expand Down Expand Up @@ -242,7 +242,7 @@ to direct workflow execution.

```yaml
with:
itk-wheel-tag: 'v5.3.0'
itk-wheel-tag: 'v5.4.5'
```

- `itk-python-package-tag`: The git tag or commit hash for ITKPythonPackage build scripts to use.
Expand All @@ -254,7 +254,7 @@ to direct workflow execution.

```yaml
with:
itk-python-package-tag: 'v5.3.0'
itk-python-package-tag: 'v5.4.5'
```

- `itk-python-package-org`: The GitHub organization to reference for fetching ITKPythonPackage build scripts.
Expand Down Expand Up @@ -292,7 +292,7 @@ to direct workflow execution.

```yaml
with:
python3-minor-versions: '["7","8","9","10","11"]` # Builds for Python 3.7 through 3.11
python3-minor-versions: '["9","10","11"]` # Builds for Python 3.9 through 3.11
```

- `manylinux-platforms`: Array of [manylinux](https://github.com/pypa/manylinux)
Expand Down Expand Up @@ -342,7 +342,7 @@ on GitHub.

## Frequently Asked Questions

### What target platforms and architectures are supported?
### What target platforms and architectures are supported (as of March 2023)?
Copy link
Member

Choose a reason for hiding this comment

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

It could come as an other PR, but for ITK 5.4.5:

C++: amd64 - mac, linux, windows, arm - mac
Python: amd64 - linux 2.17+, glibc, 2.28+, windows, arm - mac-14, linux glibc 2.28+

ITK 6:

C++: amd64 - mac, linux, windows, arm - mac
Python: amd64 - linux glibc 2.28+, windows, arm - mac-15, linux glibc 2.28+


The `build-test-cxx` workflow supports building and running C++ tests on GitHub Actions runner images for
Windows, Linux, and macOS. Image details are available [here](https://github.com/actions/runner-images).
Expand Down