Skip to content

Add a README on how to run with act #432

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

Open
matthiasdiener wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Add a README on how to run with act #432

Show file tree
Hide file tree
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
43 changes: 43 additions & 0 deletions .github/workflows/README_act.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Running GitHub CI locally with `act`
Copy link
Contributor Author

@matthiasdiener matthiasdiener Jan 26, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Does this file need a copyright line?


The `act` tool (https://github.com/nektos/act) allows you to run GitHub Actions
workflows locally using Docker. This can be useful for debugging CI logic,
reproducing failures, or iterating on workflow changes without pushing commits
to GitHub.

## Installation

There is currently no official Ubuntu package for `act`. Installation options
include:

- Pre-built binaries, available at
https://nektosact.com/installation/index.html#pre-built-artifacts
- The conda-forge package:
https://github.com/conda-forge/act-feedstock

Make sure that Docker is installed and that your user has permission to access
the Docker daemon.

## Running the TransformerEngine CI workflow

To run the CI job locally, use:

```console
$ act -j build_and_test --matrix runner:linux-mi325-8 -P linux-mi325-8=-self-hosted
```

## Caching and Cleanup

`act` caches intermediate data (such as runner state and action checkouts) in
`~/.cache/act`. This cache can grow significantly over time and is safe to
delete if disk space becomes an issue.

To inspect the current size of the cache:

```console
$ du -sh ~/.cache/act/
```

The workflow launches Docker containers internally. If an `act` run
is interrupted, containers may be left running and consume disk space. Use
`docker ps` and `docker rm -f` to clean up if needed.
2 changes: 1 addition & 1 deletion transformer_engine/common/ck_fused_attn/aiter_prebuilt.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ function(download_aiter_prebuilt DOWNLOAD_SUCCESS)
message(STATUS "[AITER-PREBUILT] NVTE_AITER_PREBUILT_BASE_URL is set - Attempting to download ${KEY}.tar.gz ...")

# Check if ${KEY}.tar.gz exists in the URL provided.
file(DOWNLOAD "${FILE_URL}.sha256" "/tmp/aiter_prebuilt_sha256.txt" STATUS sha_status LOG sha_log)
file(DOWNLOAD "${FILE_URL}.sha256" "/tmp/aiter_prebuilt_sha256.txt" STATUS sha_status LOG sha_log SHOW_PROGRESS)
Copy link
Contributor Author

@matthiasdiener matthiasdiener Jan 26, 2026

Choose a reason for hiding this comment

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

Not really related to the rest of the PR, but perhaps nice to have?

list(GET sha_status 0 sha_code)
if(NOT sha_code EQUAL 0)
message(WARNING " [AITER-PREBUILT] Prebuild file with Key=${KEY} not available in the NVTE_AITER_PREBUILT_BASE_URL provided.")
Expand Down
Loading