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

Even more backwards compatible (well sort of) #616

Merged
merged 2 commits into from
Apr 10, 2024

Conversation

apaleslimghost
Copy link
Member

  • adds a version field to .toolkitrc
  • refuses to load a (non-app-root) plugin that doesn't match the const for the currently supported version (now 2)

this should provide users with more actionable error messaging if they have outdated plugins, instead of trying to load an old toolkitrc expecting the current structure and which will probably throw some cannot read property of undefined error at some point

@apaleslimghost apaleslimghost requested a review from a team as a code owner April 10, 2024 09:36
Comment on lines +45 to +51
return invalid([
`plugin ${s.plugin(id)} has a v${s.code((plugin.rcFile.version ?? 1).toString())} ${s.code(
'.toolkitrc.yml'
)}, but this version of Tool Kit can only load v${s.code(
CURRENT_RC_FILE_VERSION.toString()
)}. please update this plugin.`
])
Copy link
Member

Choose a reason for hiding this comment

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

thought: Some assisting documentation to add as part of the major release to explain why this was done.

Copy link
Member Author

Choose a reason for hiding this comment

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

yep. documentation (including a migration guide) will be coming later.

Copy link
Contributor

@ivomurrell ivomurrell left a comment

Choose a reason for hiding this comment

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

good idea!

Base automatically changed from slightly-more-backwards-compatible to CPP-1852-task-vs-plugin-options April 10, 2024 10:51
Base automatically changed from CPP-1852-task-vs-plugin-options to next April 10, 2024 13:09
@apaleslimghost apaleslimghost force-pushed the even-more-backwards-compatible-well-sort-of branch from 8b7f3a4 to f685467 Compare April 10, 2024 13:10
@apaleslimghost apaleslimghost force-pushed the even-more-backwards-compatible-well-sort-of branch from f685467 to a49c1aa Compare April 10, 2024 13:14
@apaleslimghost apaleslimghost merged commit b5b45b0 into next Apr 10, 2024
15 checks passed
@apaleslimghost apaleslimghost deleted the even-more-backwards-compatible-well-sort-of branch April 10, 2024 13:20
ivomurrell pushed a commit that referenced this pull request Sep 5, 2024
…atible-well-sort-of

Even more backwards compatible (well sort of)
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.

3 participants