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

Fix release markdown rendering of double newlines #69

Open
glensc opened this issue Jan 18, 2022 · 9 comments
Open

Fix release markdown rendering of double newlines #69

glensc opened this issue Jan 18, 2022 · 9 comments

Comments

@glensc
Copy link

glensc commented Jan 18, 2022

Originally posted to laminas/automatic-releases#176

Because there's a double newline between two lists, markdown renders every item with double newlines and considers the two lists as one.

The workaround is to put some non-list element(s) between the lists.

Current behavior

image

markdown source
### Release Notes for [0.19.1](https://github.com/perftools/xhgui/milestone/19)

0.19.x bugfix release (patch)

### 0.19.1

- Total issues resolved: **0**
- Total pull requests resolved: **4**
- Total contributors: **2**

 - [442: Cleanup:  Remove adding ext-phar for build in Dockerfile](https://github.com/perftools/xhgui/pull/442) thanks to @glensc
 - [441: Set GIT_AUTHOR_NAME/GIT_AUTHOR_EMAIL via env rather secrets](https://github.com/perftools/xhgui/pull/441) thanks to @glensc
 - [438: Feature: Add driver name to PdoRepository](https://github.com/perftools/xhgui/pull/438) thanks to @glensc
 - [436: Implement pdo: getForUrl(), getPercentileForUrl(), getAll()](https://github.com/perftools/xhgui/pull/436) thanks to @fengqi

Expected behavior

image

markdown source
### Release Notes for [0.19.1](https://github.com/perftools/xhgui/milestone/19)

0.19.x bugfix release (patch)

### 0.19.1

Summary:
- Total issues resolved: **0**
- Total pull requests resolved: **4**
- Total contributors: **2**

Pull requests:
 - [442: Cleanup:  Remove adding ext-phar for build in Dockerfile](https://github.com/perftools/xhgui/pull/442) thanks to @glensc
 - [441: Set GIT_AUTHOR_NAME/GIT_AUTHOR_EMAIL via env rather secrets](https://github.com/perftools/xhgui/pull/441) thanks to @glensc
 - [438: Feature: Add driver name to PdoRepository](https://github.com/perftools/xhgui/pull/438) thanks to @glensc
 - [436: Implement pdo: getForUrl(), getPercentileForUrl(), getAll()](https://github.com/perftools/xhgui/pull/436) thanks to @fengqi

@WyriHaximus
Copy link
Collaborator

Interesting, and I assume this only happens because you don't group by labels 🤔 . Let me see, this should be fairly easy to fix.

@glensc
Copy link
Author

glensc commented Jan 19, 2022

yeah, I don't have any labels in the project

i was thinking if you out of ideas what to put between lists, perhaps a <hr> aka ---- or some &nbsp; trickery

@WyriHaximus
Copy link
Collaborator

Could be, but I also like the Pull requests as a seperator. it also turned out to be a bit trickier to do then I thought. But will continue tonight

WyriHaximus added a commit that referenced this issue Jan 22, 2022
Refs: #69
Drops usage of older version of `ocramius/package-versions`
WyriHaximus added a commit that referenced this issue Jan 22, 2022
This label, when set, will function as a fallback for any items that are not grouped by any label.

Refs: #69
@WyriHaximus
Copy link
Collaborator

@glensc How would #71 work for you? You'd had to set an extra flag, but that will group everything not matched by (other) labels under the one you specify by the flag.

WyriHaximus added a commit that referenced this issue Jan 22, 2022
This label, when set, will function as a fallback for any items that are not grouped by any label.

Refs: #69
@glensc
Copy link
Author

glensc commented Jan 23, 2022

@WyriHaximus once it's merged and released I have to motivate laminas guys. so if it's enabled by default it would be easier for me :D

@WyriHaximus
Copy link
Collaborator

@glensc The only issue with enabling it by default is that would be a backward compatibility break, and that I don't have a good default word.

@WyriHaximus
Copy link
Collaborator

@glensc Jumped into that issue, let's see :)

@glensc
Copy link
Author

glensc commented Jan 23, 2022

Created laminas/automatic-releases#177. the text will appear before the pr/issue list?

@WyriHaximus
Copy link
Collaborator

It is treated like any other label.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants