Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spraxdev/action-spigotmc
This Action allows you to easily compile Minecraft Spigot and install it in your runners local maven repository.
https://github.com/spraxdev/action-spigotmc
continuous-integration github-actions minecraft minecraft-server spigot
Last synced: about 2 months ago
JSON representation
This Action allows you to easily compile Minecraft Spigot and install it in your runners local maven repository.
- Host: GitHub
- URL: https://github.com/spraxdev/action-spigotmc
- Owner: SpraxDev
- License: mit
- Created: 2020-10-19T00:29:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T18:33:55.000Z (5 months ago)
- Last Synced: 2024-11-04T15:04:56.660Z (about 2 months ago)
- Topics: continuous-integration, github-actions, minecraft, minecraft-server, spigot
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/compile-minecraft-spigot-or-paper-buildtools
- Size: 1.52 MB
- Stars: 22
- Watchers: 1
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Action-SpigotMC
This Action allows you to easily compile Minecraft Spigot
and install it in your runners local maven repository.
Supported:
* SpigotMC (using the latest version of the official BuildTools)
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.
## Usage
**Note:** Use `actions/cache` as described [here](https://docs.github.com/en/free-pro-team@latest/actions/guides/building-and-testing-java-with-maven#caching-dependencies) to save some additional time by caching between runs!
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.
```yaml
- uses: SpraxDev/Action-SpigotMC@v5
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.19.2, 1.8.8
versions: latest # Optional
# Should sources be generated?
# If enabled, BuildTools is provided the '--generate-source' argument
generateSrc: false # Optional
# Should the documentation be generated?
# If enabled, BuildTools is provided the '--generate-docs' argument
generateDoc: false # Optional
# Should we disable the BuildTools's Java-Version-Check?
# If enabled, BuildTools is provided the '--disable-java-check' argument
disableJavaCheck: false # Optional
# Should we download additional files to deobfuscate CraftBukkit and NMS?
# If enabled, BuildTools will also install additional files that are required to deobfuscate CraftBukkit and NMS with the SpecialSource-Plugin
remapped: false # Optional
# 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 # Optional
# The amount of builds allowed to run at the same time
# Set to '-1' to use system's cpu core count
threads: -1 # Optional
# You can choose between different BuildTools to be used by this action
# Available: SpigotMC
buildToolProvider: SpigotMC # Optional
# The host of the SFTP-Server to use as dedicated artifact cache
sftpCacheHost: '' # Optional
# The port of the SFTP-Server to use as dedicated artifact cache
sftpCachePort: 22 # Optional
# The username of the SFTP-Server to use as dedicated artifact cache
sftpCacheUser: '' # Optional
# The private key of the SFTP-Server to use as dedicated artifact cache
# The configured value should start with `-----BEGIN OPENSSH PRIVATE KEY-----`
sftpCachePrivateKey: '' # Optional
# Setting this to the server's host key, will enable strictly checking the host key
# something like `ssh-ed25519 [HASH]` is expected here
sftpCacheExpectedHostKey: '' # Optional
```
## Cache Spigot artifacts on a dedicated SFTP-Server
Using GitHub's `actions/cache` is already great but may not be enough for some use-cases,
causing all those Spigot versions to be recompiled more often than necessary.
To solve this, you are able to configure your own SFTP-Server that should be used to store and restore built Spigot artifacts.
To be clear, we still recommend using `actions/cache` in addition to this feature – This is not aimed to be a replacement.
In theory, using this feature allows you only build a version once and then share it across all your repositories and workflows.