Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 1.31 KB

README.md

File metadata and controls

41 lines (31 loc) · 1.31 KB
Raw

Scenamatica Action

Scenamatica is a tool for automatically scenario testing your PaperMC plugins.
Scenamatica Action is a GitHub Action for running Scenamatica automatically.

Usage

See action.yaml

on:
  push:
  pull_request:

permissions:
  pull-requests: write  # For writing pull request comments(optional)

# ...
steps:
- uses: TeamKUN/
  with:
    # The path to the plugin jar file.
    plugin: "target/YourPlugin-1.0.0.jar"
    # The scenamatica version to use. (default: <DEPENDS ON THE ACTION VERSION>)
    scenamatica: "0.4.0"
    # The Minecraft version(default: 1.16.5)
    minecraft: "1.16.5"
    # The server directory to run the tests. (default: "server")
    server-dir: "server"
    # The token to use for the GitHub API(Writing pull request comments). (default: ${{ github.token }})
    github-token: ${{ github.token }}
    # Whether to generate a summary of the test results in the form of a graph.
    graphical-summary: true

If you want to run tests on pull requests, you need to set the pull-requests permission to write in the permissions section.

More Information

Please see the Scenamatica documentation for more information(ONLY IN JAPANESE).