Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple h1s in Changelog - there should only be one #208

Closed
marcysutton opened this issue Sep 1, 2017 · 10 comments
Closed

Multiple h1s in Changelog - there should only be one #208

marcysutton opened this issue Sep 1, 2017 · 10 comments

Comments

@marcysutton
Copy link

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).

@ungoldman
Copy link

100% agree! I filed an issue here: conventional-changelog/conventional-changelog#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).

@marcysutton
Copy link
Author

Thanks! I added a comment over there.

@bcoe
Copy link
Member

bcoe commented Sep 3, 2017

@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.

@stevemao
Copy link
Member

stevemao commented Sep 4, 2017

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

@ungoldman
Copy link

stevemao pushed a commit to conventional-changelog/conventional-changelog that referenced this issue Jan 18, 2018
Related issues:
- #214 (comment)
- conventional-changelog/standard-version#208

BREAKING CHANGE: 

Logic for generating release headings has been changed to make all
heading levels the same (`##`/`h2`) for better compatibility with
screen readers and parsers, and to conform to HTML semantics. Patch
release titles are now wrapped in a `<small>` tag to maintain the
visual hierarchy of the previous style.

Fixes #214
@aaronjameslang
Copy link

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?

@naltatis
Copy link

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

@NateScarlet
Copy link

Same issue
Using postchangelog hook for [email protected]

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

@bcoe
Copy link
Member

bcoe commented Apr 4, 2019

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

@bcoe
Copy link
Member

bcoe commented May 5, 2019

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

@bcoe bcoe closed this as completed May 5, 2019
AlexGuz23 pushed a commit to AlexGuz23/conventional-changelog that referenced this issue Nov 3, 2022
Related issues:
- conventional-changelog/conventional-changelog#214 (comment)
- conventional-changelog/standard-version#208

BREAKING CHANGE: 

Logic for generating release headings has been changed to make all
heading levels the same (`##`/`h2`) for better compatibility with
screen readers and parsers, and to conform to HTML semantics. Patch
release titles are now wrapped in a `<small>` tag to maintain the
visual hierarchy of the previous style.

Fixes conventional-changelog/conventional-changelog#214
AlerqiKeskin pushed a commit to AlerqiKeskin/conventional-changelog that referenced this issue Feb 27, 2023
Related issues:
- conventional-changelog/conventional-changelog#214 (comment)
- conventional-changelog/standard-version#208

BREAKING CHANGE: 

Logic for generating release headings has been changed to make all
heading levels the same (`##`/`h2`) for better compatibility with
screen readers and parsers, and to conform to HTML semantics. Patch
release titles are now wrapped in a `<small>` tag to maintain the
visual hierarchy of the previous style.

Fixes conventional-changelog/conventional-changelog#214
Serhii524 pushed a commit to Serhii524/h_conventional that referenced this issue Dec 28, 2024
Related issues:
- conventional-changelog/conventional-changelog#214 (comment)
- conventional-changelog/standard-version#208

BREAKING CHANGE: 

Logic for generating release headings has been changed to make all
heading levels the same (`##`/`h2`) for better compatibility with
screen readers and parsers, and to conform to HTML semantics. Patch
release titles are now wrapped in a `<small>` tag to maintain the
visual hierarchy of the previous style.

Fixes conventional-changelog/conventional-changelog#214
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

7 participants