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.

Writing changesets with headings results in unexpected heading structure

See original GitHub issue

Affected Packages

apply-release-plan

Problem

When writing a changset and you want to separate different parts of the change you can use headings, so for example:

## Summary

words

## Migration strategies

words

And so on. Unfortunately in the context of the wider CHANGELOG these headers now are no longer under their appropriate major minor patch heading, which kind of sucks! You can see an example here https://bitbucket.org/atlassian/atlassian-frontend-mirror/src/master/design-system/button/CHANGELOG.md, sometimes even a h2 is used which also breaks versions! Not great.

Proposed solution

I see two paths.

  1. Re-write headings so they make sense underneath ### Major and so on.
  2. Block headings altogether from changesets

Issue Analytics

  • State:open
  • Created 3 years ago
  • Comments:10 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
emmatowncommented, Mar 2, 2021

Sure but let’s say a changeset has an h4 in the summary, should it be changed? should it stay the same? should h4-6 be banned? should h1-3 be banned instead? There will be different opinions on these and apply-release-plan should shouldn’t have to have opinions on it.

Also, there have been vague thoughts that changelog generators should be able to change stuff like those headings.

1reaction
emmatowncommented, Feb 11, 2021

I’m fine with the first path as long as this is only a thing in the changelog generators(i.e. not apply-release-plan but cli/changelog, changelog-git and changelog-github)

Read more comments on GitHub >

github_iconTop Results From Across the Web

Headings | Web Accessibility Initiative (WAI) - W3C
Heading ranks. Exception for fixed page sections · Organize passages of text · Headings that reflect the page organization. Main heading before navigation;...
Read more >
Headings, body paragraphs and numbering – Help
In Microsoft Word, inserting such body-paragraphs-without-numbering in the middle of a list, often leads to unexpected results — e.g., because the numbering ...
Read more >
$BATCH request in SAP GATEWAY
Example: I have CHANGESET request where I must create 'Sales Order Header' entity 'Sales Order Item' entity. In this case I either want...
Read more >
5 heading accessibility issues and how to fix them
To fix no heading structure, simply add headings. Typically, you'll have one heading 1 for the page's title, and then sub-headings to split...
Read more >
Known Issues · Releases · Summer '22 - Trailblazer Community
A known issue may cause field headers to show as blank when previewing data in a recipe. This appears to impact connected datasets...
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