Skip to content

Changelog data structure

Hans5958 edited this page Jun 23, 2021 · 4 revisions

This is the strucutre of the changelog data.

Version

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

Index

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

Tag

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

Name

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

Date

The date of the release. Must be 2021-12-31

Status

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

Entry

The changelog entry of the release. Supports Markdown.

Highlights

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

Description

The description of the highlights.

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.

ImageAlt (optional)

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

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.

Clone this wiki locally