Release Notes

常見問題

1. What format do my release notes need to be in?

Use the provided release-notes-sample.json file for inspiration. They should fall under the format of an associative array, where the key for each release notes is the full version (x.x.x).

{
    "1.1.0":{
        "release_description" : "Version 1.1 of Release Notes has some new features.",
        "release_date" : "2017-09-01 00:00:00",
        "release_notes" :[
            {
                "note_title"       : "All da features",
                "note_description" : null,
                "note_bullets"     :[
                    "<mark>Mark it up!</mark>"
                ]
            }
        ]
    },
    "1.0.0":{
        "release_description" : "Version 1.0 of Release Notes is a major release that includes a fun new way to view release notes for themes.",
        "release_date" : "2017-08-01 00:00:00",
        "release_notes" :[
            {
                "note_title"       : "Initial commit",
                "note_description" : "You can optionally include descriptions. Otherwise, omit it or make its value null`",
            "note_bullets"     :[
                "Supports <b>text</b> <i>styles</i>",
                "And other stuff"
            ]
        },

        {
            "note_title"       : "More features!",
            "note_description" : null,
            "note_bullets"     :[
                "Do what ya want"
            ]
        }
    ]
}

}`

Note that release_description and note_description are optional fields.

2. Where is the current version of the site being pulled in from?

The current version of your site will be pulled using what’s in style.css. Ideally, the most recent version in the release notes will match what’s the current version is style.css

3. It’s producing an error that says my notes are invalid

Make sure your file is valid! Use a JSON validator like JSON Lint to validate your notes.

4. It says it cannot find my release notes

Make sure your file is called release-notes.json and is located in the root directory of your theme.