Skip to content

Commit bea2fb9

Browse files
ioquatixeregon
authored andcommitted
Add some details about using asan build.
1 parent f269373 commit bea2fb9

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,18 @@ It is also possible to cache gems manually, but this is not recommended because
220220
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).
221221
So, please use `bundler-cache: true` instead and report any issue.
222222

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+
223235
## Windows
224236

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

0 commit comments

Comments
 (0)