-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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(github): Better massageMarkdown implementation #11133
fix(github): Better massageMarkdown implementation #11133
Conversation
Example: renovate-testing/test-10902-markdown-github-links-1#1 (open release notes, search for "our progress") |
package.json
Outdated
@@ -167,6 +167,8 @@ | |||
"luxon": "2.0.1", | |||
"markdown-it": "12.1.0", | |||
"markdown-table": "2.0.0", | |||
"mdast-util-find-and-replace": "1.0.0", | |||
"mdast-util-to-string": "1.0.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same versions as for remark-github
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remark-github
seems to use ^1.0.0
which not points to some higher version, check lockfile changes below
import findAndReplace from 'mdast-util-find-and-replace'; | ||
import remark from 'remark'; | ||
import type { Plugin, Transformer } from 'unified'; | ||
// eslint-disable-next-line import/no-unresolved |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@types/unist
exists in NPM while unist
doesn't 🤷♂️
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a type only package 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, should be bump the versions to make less lockfile changes?
import findAndReplace from 'mdast-util-find-and-replace'; | ||
import remark from 'remark'; | ||
import type { Plugin, Transformer } from 'unified'; | ||
// eslint-disable-next-line import/no-unresolved |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a type only package 🤔
}); | ||
} | ||
|
||
const githubExtra: Plugin<any> = (): Transformer => transformer; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we really need this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just didn't want to write this lambda in .use(...)
expression
package.json
Outdated
@@ -167,6 +167,8 @@ | |||
"luxon": "2.0.1", | |||
"markdown-it": "12.1.0", | |||
"markdown-table": "2.0.0", | |||
"mdast-util-find-and-replace": "1.0.0", | |||
"mdast-util-to-string": "1.0.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remark-github
seems to use ^1.0.0
which not points to some higher version, check lockfile changes below
Updated new dependencies to the latest version before ESM transition |
But are we adding dependencies now which we can't upgrade later due to ESM? |
Yes, it's a sad part. If I understand it right, we're making them explicit. I mean, it's just what |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We've effectively the same deps as before. Just some explicit package.json
references added.
🎉 This PR is included in version 25.69.2 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
@zharinov This broke some release notes https://github.com/visualon/docker-docuum/releases/v0.20.3 ### Release Notes
<details>
<summary>visualon/docker-docuum</summary>
### [`v0.20.3`](https://togithub.com/visualon/docker-docuum/releases/v0.20.3)
[Compare Source](https://togithub.com/visualon/docker-docuum/compare/v0.20.2...v0.20.3)
See [https://github.com/stepchowfun/docuum/releases/tag/v0](https://togithub.com/stepchowfun/docuum/releases/tag/v0).20.3 for more changes
</details> |
Seems like the |
Changes:
Implement
remark
plugin inspired by remark-github.Type declarations aren't ideal, but any interaction with syntax-tree packages is painful since we can't install fresh ESM-only packages.
Context:
Closes #10902
Documentation (please check one with an [x])
How I've tested my work (please tick one)
I have verified these changes via: