SeanOMik
/
Action-SpigotMC
mirror of https://github.com/SeanOMik/Action-SpigotMC.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
27 Commits 6 Branches 2 Tags 496 KiB
TypeScript 100%
Go to file
Christian Koop fc9adaeb2e
Merge pull request #25 from SpraxDev/prepare-v1 
Prepare for v1

* Use SpraxDev/Spgito-BuildTools by default
* Allow choosing between SpraxDev and SpigotMC BuildTools
* Improve logging and error handling
* Fix build being skipped when only one version should be build
* README.md: Fixed typos and updated description
* Improve GitHub-Actions
 		2020-11-24 19:29:36 +01:00
.github GitHub-Actions: Rename some job steps 2020-11-24 19:17:58 +01:00
dist Fix ERR_STREAM_WRITE_AFTER_END 2020-11-24 19:13:26 +01:00
src Fix ERR_STREAM_WRITE_AFTER_END 2020-11-24 19:13:26 +01:00
.gitattributes Initial commit 2020-11-01 02:29:17 +01:00
.gitignore Initial commit 2020-11-01 02:29:17 +01:00
CODE_OF_CONDUCT.md Create GitHub related files 2020-11-01 03:53:06 +01:00
CONTRIBUTING.md Create GitHub related files 2020-11-01 03:53:06 +01:00
LICENSE Initial commit 2020-11-01 02:29:17 +01:00
README.md No longer allow to configure 'target' and default to 'Spigot' 2020-11-24 18:24:19 +01:00
action.yml No longer allow to configure 'target' and default to 'Spigot' 2020-11-24 18:24:19 +01:00
package-lock.json Check for existing artifacts in local maven repository 2020-11-24 18:23:22 +01:00
package.json Check for existing artifacts in local maven repository 2020-11-24 18:23:22 +01:00
tsconfig.json Initial commit 2020-11-01 02:29:17 +01:00

README.md

Get Support on Discord Support me on Patreon

Build & Run Quality Gate Status

Action-SpigotMC

This Action allows you to easily compile Minecraft Spigot or Paper and install it in your runners local maven repository.

Supported:

  • SpigotMC (using official BuildTools or my modified one)
  • PaperMC (coming soon #26)

You configure all the versions you want, and it'll compile all the missing versions automatically. By checking for a file in the local maven repository beforehand, build times can be reduces drastically.

By default, this Action uses a fork of the original BuildTools to introduce some improvements in system compatibility and speed.

Usage

All the values already provided below are their default values.

If you don't change them, you can remove them from your workflow, as they are set automatically.

- uses: SpraxDev/Action-SpigotMC@v1
  with:
    # A comma-separated list of Spigot version that should be compiled
    # These values are later given to the BuildTools.jar as '--rev' argument
    #
    # Example: latest, 1.14.4, 1.8.8
    versions: latest

    # Should sources be generated?
    # If enabled, BuildTools is provided the '--generate-source' argument
    generateSrc: false

    # Should the documentation be generated?
    # If enabled, BuildTools is provided the '--generate-docs' argument
    generateDoc: false

    # Should we disable the BuildTools's Java-Version-Check?
    # If enabled, BuildTools is provided the '--disable-java-check' argument
    disableJavaCheck: false

    # Disables the check for existing files in the local maven repository
    # Normally, a version is skipped if it is already installed
    # in the local maven repository to speed up build time
    forceRun: false

    # The amount of builds allowed to run at the same time
    # Set to '-1' to use system's cpu core count
    threads: -1

    # You can choose between different BuildTools to be used by this action
    # 'SpraxDev' is my fork of SpigotMC's that introduces some changes (https://github.com/SpraxDev/Spigot-BuildTools/#breaking-changes)
    # Available: SpraxDev, SpigotMC
    buildToolProvider: SpraxDev