New changelog page

[acrylic-style]

Today, I made a new changelog page that looks so nice than just the .md file:

I think it would be nice to setup Github pages and host the changelog page, but do we need this? (this issue is just a suggestion)

The JSON file is needed for that to work, but it shouldn't be hard work.

Example of the JSON file:

{
  "groups": [
    {
      "display_name": "ezpp!",
      "name": "ezpp",
      "featured": true,
      "color": "#2ea",
      "entries": [
        {
          "version": "v1.10.2",
          "date": "2021-03-23T21:10:39Z",
          "entries": [
            {
              "category": "User Interface",
              "message": "Fix a bug which caused all the text to disappear in some cases (ezpp#92)",
              "author": "oamaok"
            }
          ]
        }
      ]
    },
    {
      "display_name": "libezpp",
      "name": "libezpp",
      "featured": false,
      "color": "#86e",
      "entries": [
        {
          "version": "1.0.0",
          "date": "2021-03-26T20:37:45Z",
          "entries": [
            {
              "category": "Misc",
              "message": "Initial release to reserve the name in the npm registry. Includes a basic beatmap parser.",
              "author": "oamaok"
            },
            {
              "category": "Misc",
              "message": "Initial commit, add API draft",
              "author": "oamaok"
            },
            {
              "category": "Misc",
              "message": "Add initial version of beatmap parser (libezpp#3)",
              "author": "oamaok"
            },
            {
              "category": "Misc",
              "message": "Initial release (libezpp#4)",
              "author": "oamaok"
            }
          ]
        }
      ]
    }
  ]
}

edit(2021/03/29): Updated image and json

[oamaok]

Looks nice! I'm pretty sure the generation of the changelog could be automated, just based on the pull request titles and authors from git history. We wouldn't also need to host it on github pages necessarily, as you can include static websites inside the extension. This would increase the package size of the extension, which I would like to keep relatively small.

I'll come back to this later.

[acrylic-style]

Example page: https://next.acrylicstyle.xyz/ezpp.html and JSON: https://next.acrylicstyle.xyz/api/ezpp-changelog.json

edit:

We wouldn't also need to host it on github pages necessarily

yes, but peoples without extension will be able to view the nice changelog page if we use github pages.

Also, what about category generation? It might be complex to automate using just message. It becomes much easier with labels.

[acrylic-style]

I implemented the automated changelog generation with GitHub App (bot), with some commands: https://github.com/acrylic-style/ezpp-bot You can install via here: https://github.com/apps/ezpp-bot