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.

Sign up for GitHub

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

Jump to bottom

🛠 Tooling: Changelogs violate markdownlint header-increment rule #107

Closed
3 tasks done
JoshuaKGoldberg opened this issue Dec 13, 2022 · 1 comment · Fixed by #109
Closed
3 tasks done

🛠 Tooling: Changelogs violate markdownlint header-increment rule #107

JoshuaKGoldberg opened this issue Dec 13, 2022 · 1 comment · Fixed by #109
Assignees
@JoshuaKGoldberg
Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

This is CHANGELOG.md right now:

# [1.4.0](https://github.com/JoshuaKGoldberg/template-typescript-package/compare/v1.3.0...v1.4.0) (2022-12-13)

### Features

- bind console log for performance (not really) ([#105](https://github.com/JoshuaKGoldberg/template-typescript-package/issues/105)) ([98155c5](https://github.com/JoshuaKGoldberg/template-typescript-package/commit/98155c5fdb301c78bc9a04a5933b4843fb186692))

Note the # up top. That should be a ##, with a # Changelog above it.

CHANGELOG.md:3 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]

https://github.com/JoshuaKGoldberg/template-typescript-package/actions/runs/3689565107/jobs/6245646600

https://github.com/DavidAnson/markdownlint/blob/2b2dc27f24a16a2afdf66d850a247f7ce02df6c8/doc/Rules.md#md001---heading-levels-should-only-increment-by-one-level-at-a-time

Additional Info

No response
@JoshuaKGoldberg JoshuaKGoldberg added type: bug Something isn't working :( area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! labels Dec 13, 2022
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 13, 2022
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 13, 2022
Merged
3 tasks
@JoshuaKGoldberg
Copy link
Owner Author

semantic-release/changelog#279 😞

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 13, 2022
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Oct 1, 2023
Open
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: used semantic-release/exec to clean changelog headings JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg