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

Replace website version details with a badge #149

Merged
merged 3 commits into from Mar 4, 2020

Conversation

bomanimc
Copy link
Member

@bomanimc bomanimc commented Mar 3, 2020

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:

  • 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.

Images

Before
Screen Shot 2020-03-03 at 4 03 15 PM

After
Screen Shot 2020-03-03 at 4 03 55 PM

@bomanimc bomanimc requested a review from joeyklee March 3, 2020 22:32
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.

Oh yay!!! This is excellent!

@joeyklee
Copy link
Contributor

joeyklee commented Mar 3, 2020

Approved on my side! Merge when ready!

@bomanimc bomanimc merged commit e9a1c36 into master Mar 4, 2020
@bomanimc bomanimc deleted the bomani.version-shields branch April 16, 2021 17:04
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.

None yet

2 participants