Standard-version: Multiple h1s in Changelog - there should only be one

Created on 1 Sep 2017  路  10Comments  路  Source: conventional-changelog/standard-version

The HTML output in the change logs produced by this tool include too many h1 elements. There should be one at the top for "Change Log", and the individual releases should be h2's so the content hierarchy makes sense and follows best practices for accessible headings.

Here's what it outputs now:

# Change Log

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.

<a name="3.0.0-alpha.2"></a>
# [3.0.0-alpha.2](https://github.com/dequelabs/axe-core/compare/v3.0.0-alpha.1...v3.0.0-alpha.2) (2017-09-01)

### Bug Fixes

Here's what it should be:

# Change Log

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.

<a name="3.0.0-alpha.2"></a>
## [3.0.0-alpha.2](https://github.com/dequelabs/axe-core/compare/v3.0.0-alpha.1...v3.0.0-alpha.2) (2017-09-01)

### Bug Fixes

I couldn't figure out where those come from after a quick look through the source, perhaps it's from one of the dependent modules? I'm happy to submit a PR if someone can point me in the right direction (including to another repo, if needed).

Most helpful comment

This should now be fixed as of [email protected] thanks for reporting the issue @marcysutton 馃憤

All 10 comments

100% agree! I filed an issue here: https://github.com/conventional-changelog/conventional-changelog/issues/214

The response I got indicated that this is by design, and that it's determined by this template file:

https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-writer/templates/header.hbs

I would very much like to standardize around a more semantic convention (h1 for title, h2 for version section, h3-6 for headings specific to a version).

Thanks! I added a comment over there.

@marcysutton @ungoldman for the record, I'm definitely in favor of us having valid markup! and would happily help land any tickets related to this.

Probably we don't need # Change Log at the top since the filename already suggests that?

So we need to bump the version of conventional-changelog standard-version depends on. Should we update all the deps while we're at it? Looks like it might require a major version bump, would there be resistance to this?

Any plans on upgrading to latest conventional-changelog? I ran into the same issue.

Same issue
Using postchangelog hook for [email protected]

sed -e '2,${s/^# /## /}' -e 's/Change Log/Changelog/' -i CHANGELOG.md

@NateScarlet is the fix simply upgrading the version of conventional-changelog? will do so soon, working on a release with a few exciting things.

This should now be fixed as of [email protected] thanks for reporting the issue @marcysutton 馃憤

Was this page helpful?
0 / 5 - 0 ratings

Related issues

chris-dura picture chris-dura  路  4Comments

lydemann picture lydemann  路  3Comments

vidavidorra picture vidavidorra  路  5Comments

weaintplastic picture weaintplastic  路  5Comments

kimnh-0823 picture kimnh-0823  路  4Comments