Skip to content

docs: add a migration guide#2

Open
fmartingr wants to merge 5 commits intocifrom
docs/migrationguide
Open

docs: add a migration guide#2
fmartingr wants to merge 5 commits intocifrom
docs/migrationguide

Conversation

@fmartingr
Copy link
Copy Markdown
Contributor

Summary

Add a migration guide for current plugins

@fmartingr fmartingr self-assigned this Aug 14, 2025
Copy link
Copy Markdown

@davidkrauser davidkrauser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍


5. **Update the assets with `pluginctl`**: Run `pluginctl updateassets`. This will replace and create new files in your plugin.

6. **Manually remove old asset files**: You can remove the following files:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should pluginctl offer a command to remove these?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is only needed for the initial migration, I'm not sure if we should consider removing it on updateassets automatically (with some log output) or not. What do you think?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we add a --clean option to the updateassets plugin, devs can opt into the cleanup, making it less surprising for them.

Co-authored-by: Ben Cooke <benkcooke@gmail.com>
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

Successfully merging this pull request may close these issues.

4 participants