Skip to content
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

EPIC: create-plugin update command improvements #1254

Open
6 tasks
tolzhabayev opened this issue Oct 25, 2024 · 0 comments
Open
6 tasks

EPIC: create-plugin update command improvements #1254

tolzhabayev opened this issue Oct 25, 2024 · 0 comments

Comments

@tolzhabayev
Copy link
Collaborator

tolzhabayev commented Oct 25, 2024

What are we aiming at improving?

  • Updating github workflows
  • Ability to update specific dependencies, or groups of dependencies
  • Ability to update and add files other than those inside the .config files such as package.json or .github/workflows
  • Only update package.json scripts when necessary
  • Make it possible for us to test updates in CI

Tasklist

If we want we can incrementally roll these things out without changing the current update command behaviour and use an arg of some sort to fine tune before flipping the switch.

  • Define a migration metadata schema which should contain things such as associated version, description of changes, migration file path, error messaging for each migration.
  • Create a migration manager to orchestrate the entire update process when the command is run.
  • Create test helpers that make it easy to test migrations.
  • Create a context for the migration manager to perform file system operations. It should support a rollback mechanism to make sure any failures in a single migration does not leave plugin files in a broken state.
  • Add helpers to make it easy for devs writing migrations to perform the most common tasks: updating dependencies, formatting code, running package manager commands, build config files from the handlebars templates.
  • Add an eslint rule that forbids migrations from importing node:fs to make sure they always use migration manager context

Fixes: #820
Related:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 💡 Ideation
Development

No branches or pull requests

1 participant