A GitHub Action to upload releases to hangar.papermc.io.

This is a basic example with all required options:

name: 'Upload to Hangar'

on:
  release:
    types: [published] # Only trigger on publishing releases

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      # Previous steps to create your Jar file(s).
      - uses: benwoo1110/hangar-upload-action@v1
        with:
          api_token: ${{ secrets.HANGAR_TOKEN }}
          slug: 'MyProject'
          version: ${{ github.event.release.tag_name }}
          channel: release
          files: |
            [
              {
                "path": "path/to/MyProject.jar",
                "platforms": ["PAPER"]
              }
            ]

The files option requires the input to be a valid JSON Array containing JSON objects with the following structure:

• platforms with an array of supported platform names. Allowed values are PAPER, VELOCITY and WATERFALL
• Either one of the below options:
  • path with a String representing the path to a Jar file to upload.
  • url and externalUrl with the former holding a true value and the latter a URL for the download.

Here is an example JSON array for a uploadet jar:

[
  {
    "platforms": ["PAPER"],
    "path": "path/to/MyProject.jar"
  }
]

And here an example with an external download:

[
  {
    "platforms": ["PAPER"],
    "url": true,
    "externalUrl": "https://example.com/download/MyProject.jar"
  }
]

The plugin_dependencies option requires the following Stringyfied JSON Object structure:

• <platform_name> which can be either PAPER, VELOCITY or WATERFALL based on the platform.
  • name with the name of the plugin. When externalUrl isn't used should this match an existing Project Slug.
  • required with a boolean to set wether this dependency is required or not.
  • externalUrl with a URL to the plugin. If not set (or set to null) will name be treated as a Project Slug.

Example Structure:

[
  {
    "name": "Dependency",
    "required": true,
    "externalUrl": null
  }
]

The platform_dependencies option requires the following Stringyfied JSON Object structure:

• <platform_name> which can be either PAPER, VELOCITY or WATERFALL based on the platform.
  • <array> of supported Minecraft versions. You can set specific versions (1.12), version-ranges (1.16-1.18.2) and/or supported minor versions (1.20.x).

Example Structure:

{
  "PAPER": ["1.12","1.16-1.18.2","1.20.x"]
}