Skip to content

Commit 1d9686e

Browse files
committed
Mention the new ruby-asan under Supported Versions
* 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.
1 parent bea2fb9 commit 1d9686e

File tree

1 file changed

+4
-12
lines changed

1 file changed

+4
-12
lines changed

README.md

+4-12
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby:
2222

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

25+
`ruby-asan` is the same as `ruby-head` but with AddressSanitizer (ASan) enabled, helpful for finding memory issues in native extensions.
26+
Native extensions are automatically compiled with AddressSanitizer when using `ruby-asan`.
27+
`ruby-asan` is currently only available on `ubuntu-24.04`.
28+
2529
Regarding Windows ruby master builds, `mingw` is a MSYS2/MinGW build, `head` & `ucrt` are MSYS2/UCRT64
2630
builds, and `mswin` is a MSVC/VS 2022 build.
2731

@@ -220,18 +224,6 @@ It is also possible to cache gems manually, but this is not recommended because
220224
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).
221225
So, please use `bundler-cache: true` instead and report any issue.
222226

223-
### ASan Debugging
224-
225-
Ruby can be built with AddressSanitizer (ASan) for debugging memory issues. You can use the `asan` variant of Ruby for this:
226-
227-
```yaml
228-
- uses: ruby/setup-ruby@v1
229-
with:
230-
ruby-version: asan
231-
```
232-
233-
You should also compile your own code with ASan to get the full benefits of this feature.
234-
235227
## Windows
236228

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

0 commit comments

Comments
 (0)