Skip to content
This repository has been archived by the owner on Apr 6, 2020. It is now read-only.

Part 3: Replace references to ml5 0.4.3 library version with @latest #268

Merged
merged 1 commit into from
Feb 20, 2020

Conversation

bomanimc
Copy link
Member

This is the first part of a 3 step process to switch the examples from using a specific library version numbers:

  • 1/3: Update ml5 reference script to use @latest (into development branch)
  • 2/3: Merge changes from development to release
  • 3/3: Replace references to ml5 0.4.3 library version with @latest

If we keep this repo (see discussion), maybe we can think of a better way to coordinate changes to the release and development branch!

Context

Approach:

  • Replace all references to the specific ml5 version on imports in the ml5-examples and ml5-boilerplate library with @latest. Delete scripts for updating version numbers in the files.

Pros:

  • Simplest approach for handling the ml5-example repo and ml5-boilerplate repo while also allowing them to remain separate. Overall, this is probably the least disruptive change to the current workflow.

Cons:

  • May cause some confusion about which version of the library is being used
  • If you make a sketch that specifies @latest and then come back to it a year or so later, it’s possible that there could have been breaking changes to the library that would break the script.

Copy link
Contributor

@joeyklee joeyklee left a comment

Choose a reason for hiding this comment

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

This is great. I think since we now include the version number in ml5, it will help us to debug in case people have questions.

We should keep in mind for later that having specific version numbers ensures that the library won't make breaking changes later, but for now, let's go with pruning out the devOps complexity in favor of maintainability.

Thank you!

@joeyklee
Copy link
Contributor

Merging this in now! Many thanks!

@joeyklee joeyklee merged commit 2336626 into release Feb 20, 2020
@joeyklee joeyklee deleted the bomani.switch-to-latest branch February 20, 2020 23:55
@bomanimc
Copy link
Member Author

I forgot to check to see how different the development and release branches, so Part 2 of this series will happen when the development branch gets merged into the release branch (presumably during the next time that the core library is released). The risk is that someone runs the update-ml5-references script on the release branch and it switches everything back to 0.4.3, but that seems unlikely since the release branch is seemingly handled in a special way.

I think we should be good to go on this series!

@joeyklee
Copy link
Contributor

Perfecto! 🙌

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants