Changelog Plugin

Overview

The Changelog plugin makes it easy to display update information from a file in your repository, typically named CHANGELOG.md. Within Knapsack, these contents are shown on the Changelog page, keeping everyone informed about the latest changes. You have the flexibility to update the file manually or automatically, allowing for seamless integration into your workflow.

Automatic Release and Changelog Tools

To facilitate automatic releases and changelogs, we recommend the use of the following open-source tools:

• Auto (our favorite): Find more information at https://intuit.github.io/auto/
• Semantic Release: Learn more at https://semantic-release.gitbook.io

Installation and Configuration

1. Install the @knapsack/plugin-changelog-md NPM package.
2. Add the following configuration to your knapsack.config.js file.

Adjust the changelogPath value to point to your CHANGELOG.md file

1
const { configureKnapsack } = require('@knapsack/app');
2
const {
3
  configure: configureChangelogMd,
4
} = require('@knapsack/plugin-changelog-md');
5
6
module.exports = configureKnapsack({
7
  // Point to your project's specific changelog file.
8
  plugins: [
9
    configureChangelogMd({
10
      changelogPath: './CHANGELOG.md',
11
    }),
12
  ],
13
});

Usage

With the Changelog plugin configured, the updates from your CHANGELOG.md file will be displayed in Knapsack on the Changelog page. You can manually or automatically update this file to reflect changes in your project.

The Changelog plugin greatly enhances your workflow and improves visibility into the project’s changes over time.