question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

How to customize some changelog format (date, description and order of section)

See original GitHub issue

Hello, our repo has maintained its own changelog for a while, and recently discovered this cool automation tool.

However, we want more customization of some changelog formats, including:

  1. Date format, e.g.,
<!-- Before -->
## [1.1.0](../compare/v1.0.0...v1.1.0) (2021-07-15)

<!-- After -->
## [1.1.0](../compare/v1.0.0...v1.1.0) - 2021-07-15

  1. Description, e.g.,
<!-- Before -->
# Changelog

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

<!-- After -->
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
  1. Order of section (I don’t know why the bug fixes is always displayed before feature), e.g.,
<!-- Before -->
### Bug fixes and other changes
...

### Features and improvements
...

<!-- After -->
### Features and improvements
...

### Bug fixes and other changes
...

I wonder if there is a way to do it? Thanks!

Issue Analytics

  • State:open
  • Created 2 years ago
  • Reactions:1
  • Comments:6

github_iconTop GitHub Comments

1reaction
techiesharkcommented, Jun 19, 2022

@Jasonnor I was able to get part (2) of your issue working. Originally it wasn’t for me, but then I upgraded from an older version to the latest version (9.5) of standard-version.

Here is my .versionrc.js file:

// Provides settings for standard-version tool
// See: https://github.com/conventional-changelog/standard-version

module.exports = {
  header: `# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
`
}
0reactions
Jasonnorcommented, Jun 19, 2022

@techieshark Thanks! I will reply here if I find solution for the other two. 😄

Read more comments on GitHub >

github_iconTop Results From Across the Web

Keep a Changelog
Version 1.0.0 # Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a ......
Read more >
How to change Excel date format and create custom ...
To do this, click Date in the Category list first, and select one of existing formats under Type. After that click Custom and...
Read more >
Format a date the way you want
Go back to the Category list, and choose Custom. Under Type, you'll see the format code for the date format you chose in...
Read more >
A Beginner's Guide to Git — What is a Changelog and How ...
the usual way: create a text file and start to enumerate all your changes with a specific date; the developer choice (alias the...
Read more >
Changelog best practices - Web development co-pilot
Include a link to the list of code changes. · Show release date next to each version. · Don't use regional date formats,...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found