https://github.com/teamkun/scenamatica-action

Enhance PaperMC plugin quality with its automation framework: YAML-defined tests, CI/CD integration.
https://github.com/teamkun/scenamatica-action

bukkit bukkit-plugin github-actions gtihub-action minecraft papermc papermc-plugin peyang scenario-test scenario-tester scenario-testing spigot spigot-plugin test test-automation workflow

Last synced: about 1 month ago
JSON representation

Enhance PaperMC plugin quality with its automation framework: YAML-defined tests, CI/CD integration.

• Host: GitHub
• URL: https://github.com/teamkun/scenamatica-action
• Owner: TeamKun
• License: mit
• Created: 2023-04-29T18:41:38.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-30T13:47:44.000Z (10 months ago)
• Last Synced: 2024-05-02T02:53:07.634Z (8 months ago)
• Topics: bukkit, bukkit-plugin, github-actions, gtihub-action, minecraft, papermc, papermc-plugin, peyang, scenario-test, scenario-tester, scenario-testing, spigot, spigot-plugin, test, test-automation, workflow
• Language: TypeScript
• Homepage: https://scenamatica.kunlab.org/
• Size: 1.25 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [Scenamatica](https://github.com/TeamKun/Scenamatica) Action

[Scenamatica](https://github.com/TeamKun/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](./action.yaml)

```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: )

    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](https://scenamatica.kunlab.org/) for more information\(ONLY IN JAPANESE).