Skip to content

Commit

Permalink
Mention the new ruby-asan under Supported Versions
Browse files Browse the repository at this point in the history
* Remove the ASan Debugging section for now as it seems mostly redundant.
  Native extensions are automatically compiled with ASan, so there is nothing special to do to use it.
  • Loading branch information
eregon committed Oct 11, 2024
1 parent bea2fb9 commit 1d9686e
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby:

`ruby-debug` is the same as `ruby-head` but with assertions enabled (`-DRUBY_DEBUG=1`).

`ruby-asan` is the same as `ruby-head` but with AddressSanitizer (ASan) enabled, helpful for finding memory issues in native extensions.
Native extensions are automatically compiled with AddressSanitizer when using `ruby-asan`.
`ruby-asan` is currently only available on `ubuntu-24.04`.

Regarding Windows ruby master builds, `mingw` is a MSYS2/MinGW build, `head` & `ucrt` are MSYS2/UCRT64
builds, and `mswin` is a MSVC/VS 2022 build.

Expand Down Expand Up @@ -220,18 +224,6 @@ It is also possible to cache gems manually, but this is not recommended because
There are many concerns which means using `actions/cache` is never enough for caching gems (e.g., incomplete cache key, cleaning old gems when restoring from another key, correctly hashing the lockfile if not checked in, OS versions, ABI compatibility for `ruby-head`, etc).
So, please use `bundler-cache: true` instead and report any issue.

### ASan Debugging

Ruby can be built with AddressSanitizer (ASan) for debugging memory issues. You can use the `asan` variant of Ruby for this:

```yaml
- uses: ruby/setup-ruby@v1
with:
ruby-version: asan
```

You should also compile your own code with ASan to get the full benefits of this feature.

## Windows

Note that running CI on Windows can be quite challenging if you are not very familiar with Windows.
Expand Down

0 comments on commit 1d9686e

Please sign in to comment.