Bundle a changelog#

Sysand Index presents a bundled CHANGELOG.md as the project changelog on the project page’s Changelog tab. Use this guide to let users see what changed between published project versions. A good changelog lists notable changes per published version, newest first.

To follow this guide you need an existing Sysand project. See Creating your first project if you do not have one yet.

Bundle the file#

Create a CHANGELOG.md file next to the .project.json and .meta.json files in the project root:
```
project-directory/
  .project.json
  .meta.json
  CHANGELOG.md
```

Run sysand build and confirm that the changelog is picked up:

$ sysand build
    Building kpar `/path/to/my-project/output/my_project-0.0.1.kpar`
   Including changelog from `/path/to/my-project/CHANGELOG.md`

After you publish the built .kpar file, the changelog appears on the project page’s Changelog tab.

CHANGELOG.md files are expected to contain Markdown. See Markdown support for the supported Markdown syntax.