Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juancarlospaco/nimrun-action
Nim Bisect commit-by-commit action
https://github.com/juancarlospaco/nimrun-action
bisect bug-hunting bug-reproduction bug-tracker bug-tracking-system git-bisect nim nim-lang nim-language nimlang
Last synced: 11 days ago
JSON representation
Nim Bisect commit-by-commit action
- Host: GitHub
- URL: https://github.com/juancarlospaco/nimrun-action
- Owner: juancarlospaco
- License: mit
- Created: 2022-12-13T11:05:25.000Z (almost 2 years ago)
- Default Branch: nim
- Last Pushed: 2024-05-21T01:44:48.000Z (6 months ago)
- Last Synced: 2024-05-21T03:11:13.133Z (6 months ago)
- Topics: bisect, bug-hunting, bug-reproduction, bug-tracker, bug-tracking-system, git-bisect, nim, nim-lang, nim-language, nimlang
- Language: JavaScript
- Homepage: https://gist.github.com/juancarlospaco/37da34ed13a609663f55f4466c4dbc3e
- Size: 1.89 MB
- Stars: 25
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Nimrun-Action
- [GitHub Action](https://github.com/features/actions) to bisect bugs commit-by-commit from GitHub issue comments code blocks.
https://user-images.githubusercontent.com/1189414/207674682-c971f842-b4ef-42a3-81b2-62e1c378d5a4.mp4
The bot will run the provided code on all Nim final versions from `1.0.0` to `devel`,
then finds at least 1 commit that fails and finds at least 1 commit that works,
bisects commit-by-commit between that range of commits (FAILS..WORKS),
re-builds Nim commit-by-commit and runs the code checking if it works,
until it finds 1 specific commit that introduces the Bug,
it says who, when, why, link, and files with the bug,
also reports debug info like output, IR (C/JS), AST, date/time/duration,
compiled file size, commits near with link, commits per second, etc.
Users can Bisect their own bugs, core devs get the commit that introduced the bug.
**The reduced bug repro code sample should be as tiny and simple as possible for faster performance but must have asserts.**
The Bot will match Github issue comments that first line starts with:
- `"!nim c"`
- `"!nim cpp"`
- `"!nim js"`
And followed by 1 code block of Nim source code.
# Setup
- Go to https://github.com/USER/REPO/settings/actions
- Find "Workflow permissions" section.
- Enable "Read and write permissions".
# Use
```yaml
on:
issue_comment:
types: created
jobs:
bisects:
if: |
github.event_name == 'issue_comment' && startsWith(github.event.comment.body, '!nim ') && github.event.issue.pull_request == null && github.event.comment.author_association != 'NONE'
strategy:
fail-fast: false
matrix:
platform: [ubuntu-latest, windows-latest, macos-latest]
name: ${{ matrix.platform }}-bisects
runs-on: ${{ matrix.platform }}
steps:
- uses: actions/checkout@v3
- uses: jiro4989/setup-nim-action@v1
with:
nim-version: 'devel'
- uses: juancarlospaco/nimrun-action@main
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```
- `@github-actions` adds :eyes: Reaction to your Github issue comment when seen.
- `@github-actions` adds 1 new Github issue comment with the Bisect results and stats.
# Examples
Used by Nim official repo:
- **https://github.com/nim-lang/Nim/issues/23836**
- **https://github.com/nim-lang/Nim/issues/23586**
- https://github.com/nim-lang/Nim/issues/16933#issuecomment-1620907872
- Cpp [https://github.com/nim-lang/Nim/pull/22157#issuecomment-1620858856](https://github.com/nim-lang/Nim/issues/16933#issuecomment-1620858522)
- JavaScript https://github.com/nim-lang/Nim/issues/22687#issuecomment-1723406204
# Valgrind
- Iff using ARC/ORC/AtomicARC and `-d:useMalloc` then uses Valgrind.
- Example `!nim c --gc:arc -d:useMalloc` (automatically sets `--debugger:native` etc).
- Example https://github.com/nim-lang/Nim/issues/22672#issuecomment-1711674994
- https://github.com/juancarlospaco/nimrun-action/pull/4
# Fuzzing
- Static basic [Fuzzing](https://en.wikipedia.org/wiki/Fuzzing) for primitive types for C/C++/JS targets.
- Example https://github.com/juancarlospaco/nimrun-action/issues/3#issuecomment-1673682776
```nim
random.randomize()
type O = enum A, B
echo O.fuzzing
echo int.fuzzing
echo int64.fuzzing
echo int32.fuzzing
echo int16.fuzzing
echo int8.fuzzing
echo uint64.fuzzing
echo uint32.fuzzing
echo uint16.fuzzing
echo uint8.fuzzing
echo byte.fuzzing
echo char.fuzzing
echo repr(BackwardsIndex.fuzzing)
echo bool.fuzzing
echo float.fuzzing
echo float64.fuzzing
echo float32.fuzzing
echo Positive.fuzzing
echo Natural.fuzzing
echo string.fuzzing
echo cstring.fuzzing
```
# Multiple files
If you want to provide additional files:
- Add 1 new code block with C syntax to be saved as `./temp.c`.
- Add 1 new code block with C++ syntax to be saved as `./temp.cpp`.
- Add 1 new code block with C Header syntax to be saved as `./temp.h`.
- Add 1 new code block with HPP Header syntax to be saved as `./temp.hpp`.
- Add 1 new code block with JS syntax to be saved as `./temp.js`.
- Add 1 new code block with JSON syntax to be saved as `./temp.json`.
- Add 1 new code block with TXT syntax to be saved as `./temp.txt`.
- Add 1 new code block with CFG syntax to be saved as `./temp.nim.cfg`.
For additional Nim source code files provide additional Nim code blocks,
the first Nim code block will always be the main executable named `./temp.nim`,
and additional Nim code blocks will be importable modules named as `./tempN.nim`,
with `N` being an incrementing positive integer starting with `./temp1.nim`,
then `./temp2.nim`, `./temp3.nim`, `./temp4.nim`, etc.
- Example https://github.com/nim-lang/Nim/issues/22543#issuecomment-1690562542
# Arbitrary text comment
Comment must start with the `!nim ` because it checks the first line only for performance for fast builds,
you can have any arbitrary text and links **after** the code blocks (or write the text on another comment).
- Example https://github.com/nim-lang/Nim/pull/22559#issuecomment-1693758090
# Requisites
- `jiro4989/setup-nim-action` to setup Nim.
# Articles
- https://nim-lang.org/blog/2023/01/11/this-month-with-nim.html
# Stars
:star: [@juancarlospaco](https://github.com/juancarlospaco '2023-07-06')
:star: [@moigagoo](https://github.com/moigagoo '2023-07-06')
:star: [@planetis-m](https://github.com/planetis-m '2023-07-06')
:star: [@geotre](https://github.com/geotre '2023-07-07')
:star: [@georgelemon](https://github.com/georgelemon '2023-07-07')
:star: [@gabbhack](https://github.com/gabbhack '2023-07-07')
:star: [@termermc](https://github.com/termermc '2023-07-10')
:star: [@solarizedalias](https://github.com/solarizedalias '2023-07-15')
:star: [@jmgomez](https://github.com/jmgomez '2023-09-19')
:star: [@AmjadHD](https://github.com/AmjadHD '2023-09-24')
:star: [@Blackskywork](https://github.com/Blackskywork '2023-09-30')
:star: [@tuanductran](https://github.com/tuanductran '2024-05-29')
:star: [@viluon](https://github.com/viluon '2024-07-17')