https://github.com/bwc9876/gh-grader-preview

Simple program for previewing how GitHub Classroom runs your project
https://github.com/bwc9876/gh-grader-preview

Last synced: 23 days ago
JSON representation

Simple program for previewing how GitHub Classroom runs your project

• Host: GitHub
• URL: https://github.com/bwc9876/gh-grader-preview
• Owner: Bwc9876
• License: mit
• Created: 2024-01-31T20:54:09.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-02-10T16:48:41.000Z (11 months ago)
• Last Synced: 2024-11-01T01:05:17.198Z (2 months ago)
• Language: Rust
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Grader Preview

Simple program that runs test cases specified in an autograding.json file and reports results. Useful for previewing how GitHub will run your autograder and project.

> [!WARNING]

> 

> While this works on Windows, the GitHub classroom runner uses Linux by default, and so some professors may write commands

> specific to Linux meaning they won't work for you.

## Usage

```sh

gh-grader-preview

```

Will auto-find the `autograding.json` file located in `.github/classroom` relative to the current dir.

You can specify `-f` to choose a different file.

```sh

gh-grader-preview -f some/other/dir/autograding.json

```

To see output from the test cases, use the `-v` flag.

```sh

gh-grader-preview -v

```

For more information, run `gh-grader-preview -h`.

## Building

`cargo build --release`

### Installation

Copy the binary from `target/release/gh-grader-preview` to a directory in your PATH.

Run `gh-grader-preview --man-page` to print the man page to stdout, and then save it to a file.

Run `gh-grader-preview --completions=SHELL` (replace `SHELL` with `bash`, `fish`, or `zsh`) to generate a shell completion script.