migrate-goldmark-app-v1-to-v2

Description

This skill helps you migrate a goldmark (https://github.com/yuin/goldmark) extension from version 1 to version 2. It provides guidance on the changes needed to update your project to be compatible with the new version of goldmark.

Knowledges

• CommonMark key points : List of key points of CommonMark spec that you should be aware of when implementing a goldmark extension.
• Breaking changes in v2 : List of breaking changes in goldmark v2 that you should be aware of when migrating your extension from v1 to v2.

Migration steps

Overview of the migration process

• Create a migration plan for the application.
• MUST ask human to confirm that the migration plan is acceptable before proceeding with the migration.
• MUST ask human to how to test the application after migration before proceeding with the migration.
  • e.g. : "How do you want to test the application after migration? Do you have any test cases or examples that you want to use for testing?"
• Execute the migration plan to update the application code to be compatible with goldmark v2.
• Update the test cases to ensure that the application works as expected with goldmark v2.
• Test the application with goldmark v2 to ensure that it works as expected. If there are any issues, fix them and re-test until the application works as expected.
• Update the documentation to reflect any changes made during the migration process.

Create a migration plan

Task

• Make sure you have read and understood the Breaking changes in v2 document.
• Make sure you have read and understood the How to create an extension document.
• You create a ./features/goldmark-migration-plan.md file that contains a migration plan for the extension.

Extension