Skip to content

[Feature request] Update descriptions on CurseForge, Wago, and WowInterface #187

@KyrosKrane

Description

@KyrosKrane

Use case

I store my addon description (the text describing your addon that appears on the body of your addon's page when you view it on the hosting sites) as a file in my repo - markdown for CF and Wago; and BBCode for WowI. I update the description files in my repo as I add features. After major updates, I copy/paste the contents of the files into each site to update the description. I believe the APIs for all three hosts allow for programmatically updating the description. I would like to automate this process.

General description

My first thoughts on how it would work, purposely kept a bit vague on the technical details to allow implementation flexibility.

The prerequisite is that the description must be stored in a host-compatible format (e.g., markdown, HTML, or BBCode, as required), with the whole description in one file. That file has to be in the repository. Depending on implementation, the files could be required to be at the top level of the repository, or in a specially named top-level directory.

A description file can be unique to one host, or shared among multiple hosts (e.g., both CF and Wago could share a markdown file).

The description filenames could be passed in as parameters. Perhaps something like the following:

-C CurseForgeDesc.md
-I WowInterfaceDesc.bbcode <-- parameter is capital i if it's not clear from the font
-W WagoDesc.md

Alternately, to maintain consistency, the switches could use the same letters used to set the project ID for each site, but capitalized.

-P CurseForgeDesc.md
-W WowInterfaceDesc.bbcode
-A WagoDesc.md

The specified files should automatically be excluded from packaging. If the author wants to package the files, perhaps this could be overridden with a -D command line switch.

Open questions

  • How to identify different formats - for example, CF supports both markdown and HTML formatting. Perhaps parse the file name and restrict the extension to known formats? .md or .html or .bbcode
  • How to handle an error in updating the description? What if the addon packages and uploads successfully, but the description update fails for one site?
  • If an addon fails to upload to one site but uploads successfully to others, should the description be updated for the failed site? (Most likely not.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions