Changelog

Changelog let you communicate API and product changes to your developers.

Hoss changelog comes with

• Tagging for organizing & filtering changes
• Mark change as actions required. Developer can quickly filter for breaking changes
• Future changes
• RSS
• Subscription form
• API to query for changelog and create subscription

Install

Install changelog plugin

yarn add @hoss/plugin-content-changelog

Then, add it in your site's hoss.config.js

module.exports = {
  // ...
  plugins: ['@hoss/plugin-content-changelog'],
};

Finally, add your term Markdown files to ROOT/changelog/.

website # root directory of your site
├── changelog
│   └── first-change.md
├── src
│   └── pages

The changelog will be available at http://localhost:3000/changelog

Markdown format

Changelog Markdown documents can use the following Markdown FrontMatter metadata fields, enclosed by a line --- on either side:

• title: Title of the change
• tags: A list of tags for this change, for example

  tags:
    - Shopify
    - Stripe
  

• actions_required: If this is a breaking change
• date: Date of the change. Can be a future date

API

Hoss changelog comes with API to query changes and create subscription. Learn more about Changelog API