https://github.com/fn-fal113/minecraft-plugin-runtime-test

A github action for testing minecraft plugins initialization on combination of paper server versions
https://github.com/fn-fal113/minecraft-plugin-runtime-test

action github-actions

Last synced: 3 days ago
JSON representation

A github action for testing minecraft plugins initialization on combination of paper server versions

• Host: GitHub
• URL: https://github.com/fn-fal113/minecraft-plugin-runtime-test
• Owner: FN-FAL113
• License: gpl-3.0
• Created: 2023-07-12T03:20:23.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-05T10:40:53.000Z (over 1 year ago)
• Last Synced: 2023-10-05T13:38:10.224Z (over 1 year ago)
• Topics: action, github-actions
• Language: JavaScript
• Homepage:
• Size: 64.5 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Minecraft Plugin Runtime Test

Github action for testing minecraft plugins initialization during server load on different versions of paper server.

![image](https://github.com/FN-FAL113/minecraft-plugin-runtime-test/assets/88238718/5086ee38-b1a3-4860-961a-1929124db85c)

### How it works

#### Prerequisite Steps (Building the plugin)

1. Checkout repository (in the context of the action caller)

2. Download plugin build artifact from previous workflow build job

3. Set up Java 17

4. Setup Node 16

5. Execute index.js file

#### index.js (When this action is called)

1. Create and initialize ```eula.txt```

2. Fetch latest paper server build

3. Download paper server jar (server version from matrix variable as input data to this action) 

4. Execute mc server

### Usage

- Create an action file inside ```./github/workflows``` in the scope of your plugin repository and configure the steps if necessary:

```yml

name: Build with Maven and Do Runtime Test

on:

  workflow_dispatch:

  push:

    branches:

      - main

  pull_request:

    branches:

      - main

    

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - name: Checkout Repository

      uses: actions/[email protected]

      

    - name: Set up JDK 16

      uses: actions/[email protected]

      with:

        java-version: 16

        

    - name: Maven Build

      run: mvn clean package --file pom.xml

      

    - name: Upload the artifact

      uses: actions/upload-artifact@v3

      with:

        name: artifact-${{ github.event.number }}

        path: 'target/FNAmplifications*.jar' # Change this according to the location and filename of your packaged jar, you may use wildcards

  

  runtime-test:

    name: Plugin Runtime Test 

    needs: [build]

    runs-on: ubuntu-latest

    strategy:

      matrix:

        include:

          - mcVersion: '1.16.5'

            javaVersion: '16'

          - mcVersion: '1.17.1'

            javaVersion: '17'

          - mcVersion: '1.18.2'

            javaVersion: '18'

          - mcVersion: '1.19.4'

            javaVersion: '19'

          - mcVersion: '1.20.1'

            javaVersion: '20'  

    

    steps:        

      - uses: FN-FAL113/[email protected] # specify action version, use latest as possible

        with:

          server-version: ${{ matrix.mcVersion }}

          java-version: ${{ matrix.javaVersion }}

          artifact-name: artifact-${{ github.event.number }}

```

### Plugins Included by Default During Runtime

- Slimefun

Suggestions are open for plugins that depends on other plugins. This will be based off from a resource file soon in order to accomomdate more plugins or so this repo can be forked to support your plugins.