From bea2fb915c4edb7747c25d8f71058171da86b041 Mon Sep 17 00:00:00 2001 From: Samuel Williams Date: Mon, 7 Oct 2024 10:33:44 +1300 Subject: [PATCH] Add some details about using asan build. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index f82fd2a95..fef98fd00 100644 --- a/README.md +++ b/README.md @@ -220,6 +220,18 @@ 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.