This PR introduces changes to represent the version of ML5 using a badge from Shields.io (see all templates here) instead of a hardcoded version number. This helps make it easier to release new versions of the library because we no longer need to manually update the website after every release.
Typically, the process for updating the version would be to:
Create a new branch off of the master branch named after the new version number
In the new branch, manually change the static references to the core library version to the latest version and then commit the changes (Example PR)
Merge the changes into master, which triggers a deployment to Netlify.
After these changes are merged, no steps will be required to update the website!
The tradeoff here is that we no longer show the most recent release date because Shields.io, unfortunately, doesn't handle versions for NPM releases. We could set this up later if we ever support GitHub release, though (see GitHub templates here).
Does this PR introduce a breaking change?
Nope! Though there are some cleanup changes included in this PR to remove unused fields.
What needs to be documented once your changes are merged?
I don't believe that there are any necessary documentation changes.
PR Details
What kind of change does this PR introduce?
This PR introduces changes to represent the version of ML5 using a badge from Shields.io (see all templates here) instead of a hardcoded version number. This helps make it easier to release new versions of the library because we no longer need to manually update the website after every release.
Typically, the process for updating the version would be to:
After these changes are merged, no steps will be required to update the website!
The tradeoff here is that we no longer show the most recent release date because Shields.io, unfortunately, doesn't handle versions for NPM releases. We could set this up later if we ever support GitHub release, though (see GitHub templates here).
Does this PR introduce a breaking change? Nope! Though there are some cleanup changes included in this PR to remove unused fields.
What needs to be documented once your changes are merged? I don't believe that there are any necessary documentation changes.
Images
Before
After