https://github.com/umarcor/issue-runner

Execute Minimal Working Examples (MWEs) defined in the body of Markdown files or GitHub issues.
https://github.com/umarcor/issue-runner

action actions docker example issue issue-runner issue-template mwe mwes runner-script

Last synced: 29 days ago
JSON representation

Execute Minimal Working Examples (MWEs) defined in the body of Markdown files or GitHub issues.

• Host: GitHub
• URL: https://github.com/umarcor/issue-runner
• Owner: umarcor
• License: apache-2.0
• Created: 2018-05-25T10:49:15.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T05:00:43.000Z (over 1 year ago)
• Last Synced: 2024-10-06T02:08:19.520Z (about 1 month ago)
• Topics: action, actions, docker, example, issue, issue-runner, issue-template, mwe, mwes, runner-script
• Language: Go
• Homepage: https://umarcor.github.io/issue-runner
• Size: 1.9 MB
• Stars: 8
• Watchers: 1
• Forks: 2
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  

  

  

  



---

**issue-runner** is a toolkit to retrive, set up and run Minimal Working Examples (MWEs). MWEs are defined in markdown files (such as the first comment in a GitHub issue), and external tarball(s)/zipfile(s)/file(s) can be included. It extracts sources to separate files, (optionally) invokes docker, executes the entrypoint, and cleans up.

The main use case for this toolkit is to be added to a GitHub Actions (GHA) workflow in order to monitor the issues in a repository and optionally report status/results by:

- labelling issues as `reproducible` or `fixed?`,

- adding a comment to the issue with logs and/or refs to jobs/artifacts,

- and/or making test artifacts available through a CI job

Nonetheless, the CLI tool can also be used to set up and test any MWE or issue locally.

---