-
-
Notifications
You must be signed in to change notification settings - Fork 44
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
Link references are filtered out from version entry #52
Comments
Hi! Thanks for submitting this issue! They are excluded because they are causing issues in cases where they are all listed at the end of the file. That being said, maybe we should make this a bit smarter. Instead of only excluding links, we could retrieve the links used in that section of the text. |
For now I worked around this by pulling all links out, deduping them, and appending them to the end of the release notes. This works but results in a lot of unneeded links in the release notes which then somewhat breaks the release notes section of dependabot prs OctoLinker/OctoLinker#1510. |
Tried to fix it in #58. Please have a look and tell me if it solves your issue |
@all-contributors please add @xt0rted for bug |
I've put up a pull request to add @xt0rted! 🎉 |
@mindsers sorry I missed this, I'll give it a try sometime this week and report back. |
Great! Thank you! |
@mindsers sorry for the late response. I just tested this and it seemed to work but there wasn't a blank line between the contents and list of links that are appended to it so they rendered incorrectly. The format I had was: # CHANGELOG
## Unreleased
## 0.2.0
### Added
- Link references are filtered out from version entry ([#52][])
## 0.1.0
- Blah blah blah
[#52]: https://github.com/mindsers/changelog-reader-action/issues/52 And this is what was added to the release notes: ### Added
- Link references are filtered out from version entry ([#52][])
[#52]: https://github.com/mindsers/changelog-reader-action/issues/52 Without the extra blank line |
@xt0rted Hi! It should be fixed in the new release deployed this morning. Can you try it again? |
I'm working on automating the release process for https://github.com/yannickcr/eslint-plugin-react and ran into an issue where the changelog format used doesn't fully work with this action.
Example version entry:
There's two issues due to using link references.
[`jsx-key`]
.I worked around the first issue by pulling the common links out in another step and appending them to the release notes.
The second issue is happening because of this line
changelog-reader-action/src/parse-entry.js
Line 17 in 66d9e43
What's the reason for excluding these? Would you be open to adding a new setting to skip this filter?
The text was updated successfully, but these errors were encountered: