Skip to content

Auto Report Schema

Bawnorton edited this page Sep 19, 2024 · 28 revisions

!! Not Supported in 1.18.2 !!

Config File

Opt-in to auto-reporting by creating a <modid>/neruina/auto_report.json file in your data folder or in a datapack.

Fields

Field Type Description
modid mandatory The modid to listen for. If a mod with this modid is identified as a potential source, the repository specified by repo will receive the issue. Set to * to listen to all, useful for modpacks
repo mandatory Defined by Owner/Name (NOT A URL) and is the repo where you want the automatic reports to go
title optional Title of the created issues. See Issue Title
body optional Body of the issue report. See Body Title

Unfortunately labels and assignees cannot be added as github's api requires the issue creator to have write permissions to the repository. I recommend using https://github.com/marketplace/actions/regex-issue-labeler to automatically label the generated issues.

Issue Title

Default:

[Neruina]: Ticking Exception Auto Report (<date> - <time>)

Accepts:

Parameter Replacement Modifiable
<date> The current date in Month. Day, Year format false
<time> The current time in hour:minute:second a.m./p.m. format false
<modid> The modid specified in the config true
<sources> A comma separated list of modids that were identified as potential sources false
<type> The cause of the ticking exception. One of Entity, BlockEntity, BlockState, ItemStack or Unknown true
<name> The name of the errored object true
<modloader> The mod loader being used true
<modversion> The version of the mod specified with the modid entry false
<mcversion> The Minecraft version false

Max Length: 256 Chars, rest will be cutoff with "..."

The modifiable parameters can be modified in the following ways:

<Parameter> -> Captilised replacement
<PARAMETER> -> SCREAMING CASE REPLACEMENT

Issue Body

Default:

## Automatic Report Created by **NeruinaAutoReporter**
Neruina detected a ticking exception in "<modid>" (<type>: <name>)

### Environment:
- Minecraft Version: <mcversion>
- Mod Loader: <modloader>
- Mod Version: <modversion>
    
## Report:
<details>
<summary>Generated Crash Report</summary>

<report>

</details>

This issue was created automatically by Neruina's AutoReporter. To opt-out of this feature, remove the neruina/auto_report.json file from your mod's data resources.

Accepts:

All of Issue Title and

Parameter Replacement Modifiable
<report> The generated report in a code-block false

Max Length: 65536 Chars, if exceeded <report> will be replaced by a gist, if still exceeded the issue will fail to generate.

Example:

{
  "modid": "neruina",
  "repo": "Bawnorton/NeruinaAutoReports",
  "body": "## Report:\n<report>",
  "title": "Auto Report [<sources>] (<date> - <time>)"
}
Clone this wiki locally