Add extra info (loaders, game-versions, dependencies) to GitHub Release if created

[Andre601]

It would be a really nice feature to have the action auto-append information to the GitHub Release changelog based on the provided information.

That way would also a GitHub release mention dependencies for that release.

Quick Mockup

Workflow file:

jobs:
  publish:
    # ...
    steps:
      - uses: Kir-Antipov/[email protected]
        with:
          modrinth-id: Random-Modrinth-Project
          modrinth-token: ${{ secrets.MODRINTH_TOKEN }}
          
          curseforge-id: 0123456
          curseforge-token: ${{ secrets.CF_TOKEN }}
          
          dependencies: |
            sodium | depends | *
            fabric-api | depends | *
          
          loaders: |
            fabric
          
          game-versions: |
            1.19
            1.19.1
            1.19.2
            1.19.3
            1.19.4
          
          changelog: 'Added 1.19.4 support!'
          
          files-primary: 'build/libs/MyMod-*.jar'
          version: 1.5.0+mc1.19

the above would generate a changelog like this:

Added 1.19.4 support!

Supported Loaders

Loader	MC Version(s)
fabric	1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4

Dependencies

Name	Version	Download	Type
sodium	Any	Modrinth CurseForge	Depends
fabric-api	Any	Modrinth CurseForge	Depends

---

The raw output (I made the tables fancy for readability sake):

Added 1.19.4 support!

### Supported Loaders

| Loader | MC Version(s)                        |
| ------ | ------------------------------------ |
| fabric | 1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4 |

### Dependencies

| Name       | Version | Download                                                                                                              | Type    |
| ---------- | ------- | --------------------------------------------------------------------------------------------------------------------- | ------- |
| sodium     | Any     | [Modrinth](https://modrinth.com/mod/sodium) [CurseForge](https://www.curseforge.com/minecraft/mc-mods/sodium)         | Depends |
| fabric-api | Any     | [Modrinth](https://mordinth.com/mod/fabric-api) [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api) | Depends |

I assume the biggest difficulty would be to generate the dependency table based on the provided dependencies and/or modrinth/curseforge sub-options.
Maybe a unordered list would be a better choice then?

Alternatively could a github-dependencies option be added to have specific dependencies declared...
Tho that would then either require you to provide the links yourself, or choose one of the platforms.

It's a "nice to have" idea at most, but it would be nice.

[Kir-Antipov]

I apologize for the delay in responding to your message. I have been quite busy with various personal matters, as well as working on updates for mc-publish.

I appreciate your suggestion to have the action automatically append information to the GitHub Release changelog based on the provided data. I must admit, this idea has been on my mind since the start of the project, because github-loaders, github-dependencies, and github-game-versions inputs do already exist, but they serve no functional purpose, which is quite bothersome to say the least.

Sadly, there are a couple of concerns that need to be addressed:

1. We would require a new input to enable or disable this feature.
2. The proposed solution involves a hardcoded format that may not be suitable for all users, particularly those who manage non-English projects.

So, while I would like to see a feature like this integrated into mc-publish, the suggested approach is not ideal.

I came across an intriguing suggestion (though I cannot remember the author or source) to implement a custom template format for mc-publish in order to streamline the management of multi-platform builds. This feature could potentially be advantageous for our current issue as well. For instance:

  github-changelog: %{changelog} Additional content for the existing changelog.

By adopting this method, users can utilize all available information to customize everything from file names to changelogs according to their preferences. I am seriously considering exploring this direction, as it appears to be a promising solution for more than just this specific context.

[Andre601]

Recently did this idea go through my mind.

A way to define changelog information for a specific set of loader which would only be displayed on the published site.

The main usage would be for setups using a Matrix stradegy to make multiple releases separated by their loaders.

My idea was a simple HTML comment to indicate the start and end of a section that should only be included when the provided loaders match.

As an example, having this changelog setup on a GitHub Release...

## Updated

- Updated Some-dependency from 0.9 to 1.0
<!-- START:PAPER,SPIGOT -->
- Updated Bukkit-dependency from 0.9 to 1.0
<!-- END:PAPER,SPIGOT -->

would publish this changelog on Modrinth for loader BungeeCord...

## Updated

- Updated Some-dependency from 0.9 to 1.0

...and this changelog on Modrinth for loaders Paper and Spigot

## Updated

- Updated Some-dependency from 0.9 to 1.0
- Updated Bukkit-dependency from 0.9 to 1.0

It would allow a relatively simple way of having dynamic changelogs without entries that don't matter for a specific loader.

[Kir-Antipov]

I don't know about this, to be quite frankly honest with you. Why does this approach focuses only on loaders? Why is this field so special? What about the others?

[Andre601]

It was an example. It could be extended to other things.
Main idea was a way to define changelogs for a specific loader version, such as a specific dependency only used for a particular platform.
Not sure how this could be extended to other things...