conventional-changelog/standard-version

Headings generate the same IDs

Open

#214 opened on Nov 9, 2017

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (7,442 stars) (825 forks)batch import
enhancementhelp wantedtriaged

Description

The auto generated headings (i.e. features, Bugfixes, etc) produce the same IDs in the final output (each H1, H2, H3, etc)., This could be corrected by including the version number along side the heading. (heading IDs are auto-generated by lower-casing the heading title, replacing non alpha-numerics with -. i.e. not appending the version number makes all the Features heading have the same ID assigned to them)

Also, headings should be generated at the appropriate semantic levels (i.e. only one #, and not skipping intermediate levels):

# Change Log

## v1.1.0
...
### Bugfixes v1.1.0
...
### Features v1.1.0
...
## v1.0.0
...
### Bugfixes v1.0.0
...
### Features v1.0.0
...

Using <a name="..."> anchor tags is no longer needed in HTML5 (as the heading ID provides the same functionality).

Contributor guide

Tech stack
javascriptnodejs
Domain
releasetooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptNode.jsRegex
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the code that generates CHANGELOG headings, likely in a file such as 'lib/generate *' or similar. The issue describes that heading IDs are created by lowercasing and replacing non alphanumerics with hyphens, causing duplicates for headings with same text across versions. Look for the logic that assigns heading IDs and modify it to include the version number (e.g., from the current version context). Also ensure semantic heading levels are not skipped (e.g., no jumping from H1 to H3). Check existing tests for heading generation and update them. See comments in issue #214 for any additional suggestions.