Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/HSGamer/MCReleaser
A program to publish artifacts to multiple Minecraft-related platforms
https://github.com/HSGamer/MCReleaser
docker github hangar java minecraft modrinth papermc polymart spigot spigot-api
Last synced: 3 months ago
JSON representation
A program to publish artifacts to multiple Minecraft-related platforms
- Host: GitHub
- URL: https://github.com/HSGamer/MCReleaser
- Owner: HSGamer
- Created: 2024-02-09T16:18:22.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-07-16T00:16:47.000Z (4 months ago)
- Last Synced: 2024-07-16T03:52:14.999Z (4 months ago)
- Topics: docker, github, hangar, java, minecraft, modrinth, papermc, polymart, spigot, spigot-api
- Language: Java
- Homepage:
- Size: 138 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - HSGamer/MCReleaser - A program to publish artifacts to multiple Minecraft-related platforms (Project/version management tools / In-game)
README
# MCReleaser
A program to publish artifacts to multiple Minecraft-related platforms
## Usage
### CLI
```shell
java
-Dname="Artifact Name"
-Dversion="Artifact Version"
-Ddescription="Artifact Description"
-DgameVersions="Game Versions"
-jar mcreleaser.jar
```
> Use `-D` to set environment variables as properties in camel case, e.g., `GITHUB_TOKEN` becomes `-DgithubToken`
### Docker
```shell
docker run
-e NAME="Artifact Name"
-e VERSION="Artifact Version"
-e DESCRIPTION="Artifact Description"
-e GAME_VERSIONS="Game Versions"
ghcr.io/hsgamer/mcreleaser:master
```
### Github Actions
Check [action-mcreleaser](https://github.com/HSGamer/action-mcreleaser)
## Environment Variables
### Common
| Name | Description | Required | Default |
|------------------------|----------------------------------------------|----------|---------|
| `NAME` | The name of the artifact | Yes | |
| `VERSION` | The version of the artifact | Yes | |
| `DESCRIPTION` | The description of the artifact | Yes | |
| `ANNOUNCE_MISSING_KEY` | Whether to announce the missing variables | No | `false` |
| `GAME_VERSIONS` | The game versions that the artifact supports | No | |
| `GAME_VERSION_TYPE` | The type of the game version to filter | No | |
### [Github](https://github.com/)
| Name | Description | Required | Default |
|---------------------|-------------------------------------------------|----------|---------|
| `GITHUB_TOKEN` | The Github token to publish the artifact | Yes | |
| `GITHUB_REPOSITORY` | The Github repository to publish the artifact | Yes | |
| `GITHUB_REF` | The Github ref to publish the artifact | Yes | |
| `GITHUB_DRAFT` | Whether to publish the artifact as a draft | No | `false` |
| `GITHUB_PRERELEASE` | Whether to publish the artifact as a prerelease | No | `false` |
### [Hangar](https://hangar.papermc.io/)
| Name | Description | Required | Default |
|------------------------|-----------------------------------------------------------------------------------|----------|---------|
| `HANGAR_KEY` | The Hangar API key to publish the artifact | Yes | |
| `HANGAR_PROJECT` | The Hangar project to publish the artifact | Yes | |
| `HANGAR_CHANNEL` | The Hangar channel to publish the artifact | Yes | |
| `HANGAR_GAME_VERSIONS` | The game versions that the artifact supports
Will use `GAME_VERSIONS` if set | Yes | |
| `HANGAR_PLATFORM` | The Hangar platform to publish the artifact | No | Release |
| `HANGAR_DEPENDENCIES` | The dependencies of the artifact | No | |
### [Modrinth](https://modrinth.com/)
| Name | Description | Required | Default |
|------------------------------|-----------------------------------------------------------------------------------|----------|---------|
| `MODRINTH_TOKEN` | The Modrinth token to publish the artifact | Yes | |
| `MODRINTH_PROJECT` | The Modrinth project to publish the artifact | Yes | |
| `MODRINTH_GAME_VERSIONS` | The game versions that the artifact supports
Will use `GAME_VERSIONS` if set | Yes | |
| `MODRINTH_GAME_VERSION_TYPE` | The type of the game version to filter
Will use `GAME_VERSION_TYPE` if set | No | Release |
| `MODRINTH_LOADERS` | The loaders that the artifact supports | Yes | |
| `MODRINTH_VERSION_TYPE` | The Modrinth version type to publish the artifact | No | Release |
| `MODRINTH_DEPENDENCIES` | The dependencies of the artifact | No | |
| `MODRINTH_FEATURED` | Whether to feature the artifact | No | `true` |
| `MODRINTH_UNFEATURE` | Whether to unfeature other versions | No | `true` |
### [Polymart](https://polymart.org/)
| Name | Description | Required | Default |
|---------------------|-----------------------------------------------|----------|---------|
| `POLYMART_KEY` | The Polymart API key to publish the artifact | Yes | |
| `POLYMART_RESOURCE` | The Polymart resource to publish the artifact | Yes | |
| `POLYMART_BETA` | Whether to publish the artifact as a beta | No | `false` |
| `POLYMART_SNAPSHOT` | Whether to publish the artifact as a snapshot | No | `false` |