Skip to content

Commit

Permalink
Add some details about using asan build.
Browse files Browse the repository at this point in the history
  • Loading branch information
ioquatix authored and eregon committed Oct 11, 2024
1 parent f269373 commit bea2fb9
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit bea2fb9

Please sign in to comment.