-
Notifications
You must be signed in to change notification settings - Fork 3
markdown-confluence-sync v2.4.0 #73
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
Conversation
* feat(#70): Add GitHub alerts transformation to Confluence macros --------- Co-authored-by: frankledo <[email protected]> Co-authored-by: Frank Ledo <[email protected]>
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.
Pull request overview
This PR introduces version 2.4.0 of the markdown-confluence-sync package, adding support for transforming GitHub-flavored markdown alerts into Confluence macros. The feature is disabled by default and can be enabled through the rehype.githubAlerts configuration option.
Key Changes:
- GitHub alert markers ([!NOTE], [!TIP], [!IMPORTANT], [!WARNING], [!CAUTION]) are now converted to corresponding Confluence info/note/warning/tip macros
- New rehype plugin to handle the transformation logic
- Configuration option to enable/disable the feature
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| rehype-replace-github-alerts.ts | Core implementation of the GitHub alerts to Confluence macros transformation plugin |
| rehype-replace-github-alerts.test.ts | Comprehensive test suite covering various alert transformation scenarios |
| ConfluencePageTransformer.ts | Integration of the new alerts plugin into the transformation pipeline |
| ConfluencePageTransformer.types.ts | Type definition for the githubAlerts configuration option |
| ConfluencePageTransformer.test.ts | Integration tests verifying alert transformation behavior |
| ConfluenceSync.types.ts | Type definitions for the sync configuration options |
| ConfluenceSync.ts | Registration of the githubAlerts configuration option |
| markdown-confluence-sync.config.cjs | Example configuration enabling the new feature |
| README.md | Documentation of the new GitHub alerts feature |
| CHANGELOG.md | Version 2.4.0 release notes |
| package.json | Version bump to 2.4.0 |
| missing-en.txt | Added "blockquotes" to the dictionary |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Check SPDX headers ✅ 249 files have valid headers. |
|
Check License Compliance ✅ There are 1453 dependencies with allowed licenses.
✅ Result: Valid licenses |
markdown-confluence-sync v2.4.0
Description
markdown-confluence-sync
Added
GitHub-flavored markdown alerts ([!NOTE], [!TIP], [!IMPORTANT],
[!WARNING], [!CAUTION]) are now converted to Confluence's native
info, note, warning, and tip macros. This feature is disabled by
default and can be enabled via
rehype.alertsconfiguration option.closes #70
Agreement
Please check the following boxes after you have read and understood each item.
In case this is your first contribution to this project, you will also have to add a comment with the following text: "I have read the CLA Document and I hereby sign the CLA", otherwise the PR status will fail and our bot will request you to add it. Once you have signed it in a PR, you will not have to sign it again for future contributions.