mc-publish/action.yml

# ######################################################################## #
#               WARNING: AUTO-GENERATED FILE - DO NOT EDIT!                #
#                                                                          #
# Please be advised that this is an auto-generated file and should NOT be  #
#       modified. Any changes made to this file WILL BE OVERWRITTEN.       #
#                                                                          #
#     To make changes to the contents of this file, please modify the      #
# action.template.yml file instead. This will ensure that your changes are #
#              properly reflected in the auto-generated file.              #
# ######################################################################## #
name: mc-publish
description: Your one-stop GitHub Action for seamless Minecraft project
  publication across various platforms.
author: Kir-Antipov
branding:
  color: purple
  icon: box
inputs:
  modrinth-id:
    description: The unique identifier of your Modrinth project.
    required: false
    default: ${undefined}
  modrinth-featured:
    description: Set to true to feature the version on Modrinth; false otherwise.
    required: false
    default: ${undefined}
  modrinth-unfeature-mode:
    description: Sets the behavior for unfeaturing older Modrinth versions.
    default: subset
    required: false
  modrinth-token:
    description: Your Modrinth API token.
    required: false
    default: ${undefined}
  curseforge-id:
    description: The unique identifier of your CurseForge project.
    required: false
    default: ${undefined}
  curseforge-token:
    description: Your CurseForge API token.
    required: false
    default: ${undefined}
  github-tag:
    description: The tag name for the release where assets will be uploaded.
    required: false
    default: ${undefined}
  github-generate-changelog:
    description: Set to true to generate a changelog automatically for this release;
      false otherwise. Ignored if the GitHub Release already exists.
    required: false
    default: ${undefined}
  github-draft:
    description: Set to true to create a draft release; false otherwise. Ignored if
      the GitHub Release already exists.
    required: false
    default: ${undefined}
  github-prerelease:
    description: Set to true to mark the release as a prerelease; false otherwise.
      Ignored if the GitHub Release already exists.
    required: false
    default: ${undefined}
  github-commitish:
    description: Defines the commitish value that determines where the Git tag is
      created from. Can be any branch or commit SHA. Ignored if the Git tag
      already exists.
    required: false
    default: ${undefined}
  github-discussion:
    description: If specified, creates and links a discussion of the specified
      **existing** category to the release. Ignored if the GitHub Release
      already exists.
    required: false
    default: ${undefined}
  github-token:
    description: Your GitHub API token.
    required: false
    default: ${undefined}
  files:
    description: An array of globs determining which files to upload.
    default: |
      build/libs/!(*-@(dev|sources|javadoc)).jar
      build/libs/*-@(dev|sources|javadoc).jar
    required: false
  files-primary:
    description: A glob determining the primary files to upload.
    deprecationMessage: Please, use 'files' instead.
    required: false
    default: ${undefined}
  files-secondary:
    description: A glob determining the secondary files to upload.
    deprecationMessage: Please, use 'files' instead.
    required: false
    default: ${undefined}
  name:
    description: The name of the version.
    required: false
    default: ${undefined}
  version:
    description: The version number.
    required: false
    default: ${undefined}
  version-type:
    description: The version type - alpha, beta, or release.
    required: false
    default: ${undefined}
  changelog:
    description: The changelog for this version.
    required: false
    default: ${undefined}
  changelog-file:
    description: A glob pointing to the changelog file.
    required: false
    default: ${undefined}
  loaders:
    description: An array of supported mod loaders.
    required: false
    default: ${undefined}
  game-versions:
    description: An array of supported Minecraft versions.
    required: false
    default: ${undefined}
  dependencies:
    description: An array of dependencies required by your project.
    required: false
    default: ${undefined}
  version-resolver:
    description: Controls the method used to automatically resolve game versions.
    deprecationMessage: Please, use 'game-version-filter' instead.
    required: false
    default: ${undefined}
  game-version-filter:
    description: Controls the method used to filter game versions.
    default: releases
    required: false
  java:
    description: An array of Java versions compatible with your project.
    required: false
    default: ${undefined}
  retry-attempts:
    description: Defines the maximum number of asset publishing attempts.
    default: 2
    required: false
  retry-delay:
    description: Specifies the delay (in milliseconds) between asset publishing attempts.
    default: 10000
    required: false
  fail-mode:
    description: Controls how the action responds to errors during the mod
      publishing process.
    default: fail
    required: false
  modrinth-files:
    description: An array of globs determining which files to upload.
    default: ${undefined}
    required: false
  curseforge-files:
    description: An array of globs determining which files to upload.
    default: ${undefined}
    required: false
  github-files:
    description: An array of globs determining which files to upload.
    default: ${undefined}
    required: false
  modrinth-files-primary:
    description: A glob determining the primary files to upload.
    deprecationMessage: Please, use 'files' instead.
    required: false
    default: ${undefined}
  curseforge-files-primary:
    description: A glob determining the primary files to upload.
    deprecationMessage: Please, use 'files' instead.
    required: false
    default: ${undefined}
  github-files-primary:
    description: A glob determining the primary files to upload.
    deprecationMessage: Please, use 'files' instead.
    required: false
    default: ${undefined}
  modrinth-files-secondary:
    description: A glob determining the secondary files to upload.
    deprecationMessage: Please, use 'files' instead.
    required: false
    default: ${undefined}
  curseforge-files-secondary:
    description: A glob determining the secondary files to upload.
    deprecationMessage: Please, use 'files' instead.
    required: false
    default: ${undefined}
  github-files-secondary:
    description: A glob determining the secondary files to upload.
    deprecationMessage: Please, use 'files' instead.
    required: false
    default: ${undefined}
  modrinth-name:
    description: The name of the version.
    required: false
    default: ${undefined}
  curseforge-name:
    description: The name of the version.
    required: false
    default: ${undefined}
  github-name:
    description: The name of the version.
    required: false
    default: ${undefined}
  modrinth-version:
    description: The version number.
    required: false
    default: ${undefined}
  curseforge-version:
    description: The version number.
    required: false
    default: ${undefined}
  github-version:
    description: The version number.
    required: false
    default: ${undefined}
  modrinth-version-type:
    description: The version type - alpha, beta, or release.
    required: false
    default: ${undefined}
  curseforge-version-type:
    description: The version type - alpha, beta, or release.
    required: false
    default: ${undefined}
  github-version-type:
    description: The version type - alpha, beta, or release.
    required: false
    default: ${undefined}
  modrinth-changelog:
    description: The changelog for this version.
    required: false
    default: ${undefined}
  curseforge-changelog:
    description: The changelog for this version.
    required: false
    default: ${undefined}
  github-changelog:
    description: The changelog for this version.
    required: false
    default: ${undefined}
  modrinth-changelog-file:
    description: A glob pointing to the changelog file.
    required: false
    default: ${undefined}
  curseforge-changelog-file:
    description: A glob pointing to the changelog file.
    required: false
    default: ${undefined}
  github-changelog-file:
    description: A glob pointing to the changelog file.
    required: false
    default: ${undefined}
  modrinth-loaders:
    description: An array of supported mod loaders.
    required: false
    default: ${undefined}
  curseforge-loaders:
    description: An array of supported mod loaders.
    required: false
    default: ${undefined}
  github-loaders:
    description: An array of supported mod loaders.
    required: false
    default: ${undefined}
  modrinth-game-versions:
    description: An array of supported Minecraft versions.
    required: false
    default: ${undefined}
  curseforge-game-versions:
    description: An array of supported Minecraft versions.
    required: false
    default: ${undefined}
  github-game-versions:
    description: An array of supported Minecraft versions.
    required: false
    default: ${undefined}
  modrinth-dependencies:
    description: An array of dependencies required by your project.
    required: false
    default: ${undefined}
  curseforge-dependencies:
    description: An array of dependencies required by your project.
    required: false
    default: ${undefined}
  github-dependencies:
    description: An array of dependencies required by your project.
    required: false
    default: ${undefined}
  modrinth-version-resolver:
    description: Controls the method used to automatically resolve game versions.
    deprecationMessage: Please, use 'game-version-filter' instead.
    required: false
    default: ${undefined}
  curseforge-version-resolver:
    description: Controls the method used to automatically resolve game versions.
    deprecationMessage: Please, use 'game-version-filter' instead.
    required: false
    default: ${undefined}
  github-version-resolver:
    description: Controls the method used to automatically resolve game versions.
    deprecationMessage: Please, use 'game-version-filter' instead.
    required: false
    default: ${undefined}
  modrinth-game-version-filter:
    description: Controls the method used to filter game versions.
    default: ${undefined}
    required: false
  curseforge-game-version-filter:
    description: Controls the method used to filter game versions.
    default: ${undefined}
    required: false
  github-game-version-filter:
    description: Controls the method used to filter game versions.
    default: ${undefined}
    required: false
  modrinth-java:
    description: An array of Java versions compatible with your project.
    required: false
    default: ${undefined}
  curseforge-java:
    description: An array of Java versions compatible with your project.
    required: false
    default: ${undefined}
  github-java:
    description: An array of Java versions compatible with your project.
    required: false
    default: ${undefined}
  modrinth-retry-attempts:
    description: Defines the maximum number of asset publishing attempts.
    default: ${undefined}
    required: false
  curseforge-retry-attempts:
    description: Defines the maximum number of asset publishing attempts.
    default: ${undefined}
    required: false
  github-retry-attempts:
    description: Defines the maximum number of asset publishing attempts.
    default: ${undefined}
    required: false
  modrinth-retry-delay:
    description: Specifies the delay (in milliseconds) between asset publishing attempts.
    default: ${undefined}
    required: false
  curseforge-retry-delay:
    description: Specifies the delay (in milliseconds) between asset publishing attempts.
    default: ${undefined}
    required: false
  github-retry-delay:
    description: Specifies the delay (in milliseconds) between asset publishing attempts.
    default: ${undefined}
    required: false
  modrinth-fail-mode:
    description: Controls how the action responds to errors during the mod
      publishing process.
    default: ${undefined}
    required: false
  curseforge-fail-mode:
    description: Controls how the action responds to errors during the mod
      publishing process.
    default: ${undefined}
    required: false
  github-fail-mode:
    description: Controls how the action responds to errors during the mod
      publishing process.
    default: ${undefined}
    required: false
outputs:
  modrinth-id:
    description: The unique identifier of your Modrinth project.
  modrinth-version:
    description: The unique identifier of the version published on Modrinth by this action.
  modrinth-url:
    description: The URL directing to the newly published version on Modrinth.
  modrinth-files:
    description: Array of objects, each containing details about the files published
      for the new version on Modrinth, such as file `name`, `id`, and download
      `url`.
  curseforge-id:
    description: The unique identifier of your CurseForge project.
  curseforge-version:
    description: The unique identifier of the version published on CurseForge by
      this action.
  curseforge-url:
    description: The URL directing to the newly published version on CurseForge.
  curseforge-files:
    description: Array of objects, each containing details about the files published
      for the new version on CurseForge, such as file `name`, `id`, and download
      `url`.
  github-repo:
    description: The full repository name on GitHub, formatted as 'username/repository'.
  github-tag:
    description: The Git tag associated with the new or updated release published on GitHub.
  github-url:
    description: The URL directing to the newly published version on GitHub.
  github-files:
    description: Array of objects, each containing details about the files published
      for the new version on GitHub, such as file `name`, `id`, and download
      `url`.
runs:
  using: node16
  main: dist/index.js