Changelog data structure

This is the strucutre of the changelog data.

Version

The version of the release. Must be in form of vx.x.x.

Version: v1.28.0

Index

The number of the release in chronological order, where the first is 0.

Index: 71

Tag

The Git tag of the release in https://github.com/ScratchAddons/ScratchAddons

Tag: v1.28.0

Name

The name of the release. May different compared to Version and Tag.

Name: v1.28.0

Date

The date of the release. Must be in form of yyyy-mm-dd.

Date: 2022-08-30

Status

The status of the release. Can be Released, Yanked, or Pre-released Currently only Yanked will have effect on the page.

Status: Released

Entry

The changelog entry of the release. Supports Markdown.

Entry: |
  - New addon: alternating nested block colors
  - New addon: editor find bar (previously part of “developer tools”, it can now search sounds)
  - New addon: jump to custom block definition (previously part of “developer tools”)
  - ...

Highlights

The highlights of the release that is shown on the notification modal by the extension.

Description

The description of the highlights.

Highlights:
  Description: |
    New addon: "alternating nested block colors"...
    The "editor find bar" and...

ImagePath (optional)

The path of the highlights image. Setting this will make the highlights have the image mode, and will ignore other fields that are not related to this mode.

Highlights:
  ImagePath: /assets/img/release-highlights/onion.png

ImageAlt (optional)

The alternative text of the highlights image. Used on the image mode.

Highlights:
  ImagePath: /assets/img/release-highlights/onion.png
  ImageAlt: Dog inside costume editor with Onion Skinning enabled. Credit to Scratch sprite library.

YouTubeID (optional)

The ID of the highlights YouTube video. Setting this will make the highlights have the YouTube mode, and will ignore other fields that are not related to this mode.

Highlights:
  YouTubeID: e_70jvFOmfI

Links

Additional links, above the default three links.

Links:
  Link: https://example.com
  StringKey: ChangelogPage.Links.Something

Link

The URL of the link.

StringKey

The i18n key of the display text of the link.