Changelog automation - Githubissues

TheGiddyLimit / plutonium-addon-automation

An interoperability addon which makes Plutonium play nice with automation modules.

https://thegiddylimit.github.io/plutonium-addon-automation/

MIT License

32 stars 7 forks source link

Changelog automation #73

Closed TheGiddyLimit closed 11 months ago

TheGiddyLimit commented 1 year ago

Changelogs should be:

Stored in the existing "standard" 5etools/Plutonium JSON format, to allow easy integration with existing Discord bots
Built as a single human-readable (Markdown) file and either stored in the repo, or, exposed in releases. Either way, it should then be linked from the module manifest
Added to the release notes in human-readable (Markdown) format (only the changelog for that exact version, rather than the full file)

TheGiddyLimit commented 1 year ago

As pointed out by @revilowaldow it would be good to then make use of some standard Foundry community lib to handle changelogs in-game.

https://foundryvtt.com/packages/module-credits was suggested as the de-facto changelog viewer, although likely not something we should directly depend upon. Could be worth throwing in a "recommended modules" README section, though

revilowaldow commented 11 months ago

It would be nice if the impending update for compatibility could also include this request?

TheGiddyLimit commented 11 months ago

job done, I think

revilowaldow commented 11 months ago

Think so, no post in #changelogs though, no idea what happens in hooks and discord stuff

TheGiddyLimit commented 11 months ago

true. So far as I know that's something only @lorddusk can do

paging dr. dusk; thoughts on getting https://github.com/TheGiddyLimit/plutonium-addon-automation/blob/master/meta/changelog.json piped into #changelogs? JSON's in the same format as all the usual changelogs

lorddusk commented 11 months ago

Sure, shouldn't be a problem... Set it up like the others, but make it post to /plutaddon , I'll handle the rest, and ping you in the server when it's ready for a test.

On Tue, Nov 21, 2023 at 4:24 PM, Giddy @.***(mailto:On Tue, Nov 21, 2023 at 4:24 PM, Giddy < wrote:

true. So far as I know that's something only @.***(https://github.com/lorddusk) can do

paging dr. dusk; thoughts on getting https://github.com/TheGiddyLimit/plutonium-addon-automation/blob/master/meta/changelog.json piped into #changelogs? JSON's in the same format as all the usual changelogs

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: @.***>