Skip to content

Front-matter is removed from CHANGELOG when running commit-and-tag-version #106

Closed
@TimKnight-DWP

Description

@TimKnight-DWP

Describe the bug
When I run npx commit-and-tag-version any front matter on my changelog is removed

My existing changelog has some front matter:

---
status: new
---

# Changelog

All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.

## [4.13.0](https://gitlab.com/.../compare/4.12.3...4.13.0) (2023-10-18)

### Features

Current behavior

# Changelog

All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.

## [4.13.2](https://gitlab.com/.../compare/4.13.0...4.13.2) (2023-10-19)

Front matter is removed

Expected behavior
Front matter should be maintained, so that we can attach fuller metadata to our changelogs

Environment

  • commit-and-tag-version version(s): Latest
  • Node/npm version: npm 18
  • OS: Mac OS

Possible Solution

I am unsure where to start looking through the code, I presume it is something in the parse/write process, where the front matter gets stripped off before or after the new commit history is added

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions