Document plugin manifests #25
Conversation
| [the DalamudPackager source]: | ||
| https://github.com/goatcorp/DalamudPackager/blob/084f66e6af7edbf8a45820590ca71765376b901c/DalamudPackager/DalamudPackager.cs#L303 | ||
| [the properties Dalamud will load]: | ||
| https://github.com/goatcorp/Dalamud/blob/532781308d6291a2c0117e0e73a8252358e2d91a/Dalamud/Plugin/Internal/Types/PluginManifest.cs |
There was a problem hiding this comment.
You should link to IPluginManifest instead. It'll have all of the fields documented, instead of inheritdoc. I would also prefer if you linked to the Dalamud source as the "main" point.
|
Changed the link to IPluginManifest, and added some details on changelogs. I'm not 100% sure about the note about PR descriptions not being visible in the plugin installer – would be good to get confirmation that I've correctly interpreted the various related messages on Discord, XLWebServices/Plogon code, and the current changelogs of various plugins. (There's some further detail about |
|
|
||
| :::warning | ||
|
|
||
| If you'd like your changelog to be visible in the plugin installer, you must |
There was a problem hiding this comment.
This isn't accurate, changelogs in PR descriptions will also show up in the installer. At the very least they will be in the changelogs tab, if they're not in the installed plugins menu, that would be a bug - should be a simple backend change though.
There was a problem hiding this comment.
Turns out the situation is more complex than either of us thought.
Take Daily Duty v4.0.6.1 (goatcorp/DalamudPluginsD17#2930) as an example. There's no changelog in manifest.toml or in the plugin manifest, but there is a PR description, and it does not contain nofranz.
- It was, correctly, posted in Discord
- It does not show up in the installed plugins tab
- I think this is because its PluginMaster entry has null
Changelog
- I think this is because its PluginMaster entry has null
- It does not show up in my changelog tab
- and yet https://kamori.goats.dev/Plugin/History/DailyDuty?track=stable shows it!
- the last Daily Duty changelog I see is from 4.0.3.1, which matches https://kamori.goats.dev/Plugin/History/DailyDuty?track=testing-live
- I'm not using Daily Duty from testing ("receive plugin testing versions" unchecked), so this seems like a bug
- presumed cause: the PluginMaster entry has
"_Dip17Channel": "testing-live", and it seems like DalamudChangelogManager uses that to figure out which changelogs to pull https://github.com/goatcorp/Dalamud/blob/22d27fbb192d2d9b746853cfe376b01c1ebb6492/Dalamud/Interface/Internal/Windows/PluginInstaller/DalamudChangelogManager.cs#L56-L59
| Plugin updates are usually automatically posted in the XIVLauncher & Dalamud | ||
| Discord server. If you'd rather write an announcement message yourself, you can | ||
| prevent the automatic post by starting your Pull Request description with the | ||
| word `nofranz`. Note that any changelog you write in `manifest.toml` or the |
There was a problem hiding this comment.
It's fine to remove this if we fix the behavior I mentioned above, to avoid confusion. The selected changelog at time of check-in should be what's displayed everywhere, and nothing if there is none.
There was a problem hiding this comment.
I'd rather document the current state of things, rather than confuse the situation more by describing the way it should work in an ideal world.
|
won't be able to get this updated til next week, sorry; I'll recheck what the state of things is then |
|
i have no idea what the current state of anything is and no motivation to check, unless someone else does or goat remembers what he changed then this will just continue to languish |
substantially based on Franz's messages here: https://discord.com/channels/581875019861328007/860813266468732938/1212577414807429170
adjacent things that aren't included:
potentially this page's content as I've written it could plausibly live in the DalamudPackager readme? but the additional context about changelogs and icons, if I get round to writing it, definitely doesn't fit there
(sidenote: it looks like existing files are hard-wrapped at 80 columns but I can't see an editorconfig or similar to encourage that; I can add one if desired)