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.

Sign up for GitHub

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

Jump to bottom

Restore v3.0.9 URLs and Fix JSFiddle examples. #1356

Merged
merged 5 commits into from
Apr 25, 2022
Merged

Restore v3.0.9 URLs and Fix JSFiddle examples. #1356

merged 5 commits into from
Apr 25, 2022

Conversation

ronyeh
Copy link
Collaborator

@ronyeh ronyeh commented Mar 30, 2022

Work in progress:

  • Adds a step to the release script where we patch version 3.0.9 with a console.warn() message to upgrade to VexFlow 4. We publish this version at the old URL to fix any live deployments that reference the old URL.
  • As part of my work in updating the wiki and fixing JSFiddles, I am starting to include the JSFiddle examples in the repository itself. This will make it easier to maintain going forward. If any changes are needed (e.g., if VexFlow 5 breaks something), we can make the changes in the repo and copy the code directly into the JSFiddles, instead of editing the code on the JSFiddle editor.

@ronyeh ronyeh changed the title Restore v3.0.9 URL and Fix JSFiddle examples. Restore v3.0.9 URLs and Fix JSFiddle examples. Mar 30, 2022
@ronyeh
Add "changelog: true" to release-it options in Gruntfile.js to enable…
69990e7 
… the commit message summary for future GitHub releases.
@ronyeh
Add a grunt script to restore version 3.0.9 to NPM, with a console.wa…
6c96dcf 
…rn() to upgrade to VexFlow 4.
@ronyeh
Fix JSFiddle examples and update URLs.
99f3e2c
@ronyeh
Add JSFiddle examples from the wiki.
5e3a1f2 
They are easier to maintain in the repository.
If updates are required, just copy and paste the source into the target JSFiddle.
@ronyeh
Copy link
Collaborator Author

ronyeh commented Apr 20, 2022

OK, I now have some time to finish this up.

I searched for the top VexFlow examples and JSFiddles, and took a look at the broken examples. These are the URLs that the broken examples use:

UNPKG.com
	https://unpkg.com/vexflow/releases/vexflow-debug.js
	https://unpkg.com/vexflow/releases/vexflow-debug.js
	https://unpkg.com/vexflow/releases/vexflow-debug.js
	https://unpkg.com/vexflow/releases/vexflow-debug.js
	https://unpkg.com/vexflow/releases/vexflow-min.js
	https://unpkg.com/vexflow/releases/vexflow-min.js
NPMCDN.com is just a redirect to UNPKG.com, so the following URLs are the same:
	https://npmcdn.com/vexflow/releases/vexflow-debug.js
	https://npmcdn.com/vexflow/releases/vexflow-debug.js
	https://npmcdn.com/vexflow/releases/vexflow-debug.js
	https://npmcdn.com/vexflow/releases/vexflow-debug.js
	https://npmcdn.com/vexflow/releases/vexflow-debug.js
	https://npmcdn.com/vexflow/releases/vexflow-debug.js
	https://npmcdn.com/vexflow/releases/vexflow-debug.js
RAWGIT.com is no longer supported, and this would only work if we keep vexflow-debug.js in the master branch of the repository.
	https://rawgit.com/0xfe/vexflow/master/releases/vexflow-debug.js
	https://rawgit.com/0xfe/vexflow/master/releases/vexflow-debug.js

A few JSFiddle examples (which are NOT broken) use these URLs:

http://vexflow.com/support/vexflow-min.js
http://www.vexflow.com/support/vexflow-min.js
http://www.vexflow.com/support/vexflow-min.js

This PR will fix the npmcdn.com and unpkg.com URLs, which will fix the most common JSFiddle examples. This PR will NOT fix the rawgit.com URL.

@ronyeh
Clean up the script which restores legacy version 3.0.9 during release.
cc27e2f 
Modify package.json to include version 3.0.9 files in the npm release.
Fix JSFiddle examples.
Improve the warning message in the version 3.0.9 files.
@ronyeh ronyeh marked this pull request as ready for review April 21, 2022 07:34
@ronyeh
Copy link
Collaborator Author

ronyeh commented Apr 21, 2022 •
edited
Loading

OK this is ready for review!
Let me know if you have any questions.

Once this is merged, we can make a 4.0.2 release which includes the recent fixes. Let me know if there are any other open PRs that should go into this release.

rvilarl
rvilarl approved these changes Apr 21, 2022
View reviewed changes
Copy link
Collaborator

@rvilarl rvilarl left a comment

Choose a reason for hiding this comment

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

Thanks Ron!LGTM only one comment @0xfe suggested to use only Factory based examples in #775. Perhaps the new exmaples should be created using Factory rather than Native API

@rvilarl rvilarl added the 4.0.2 label Apr 21, 2022
@ronyeh
Copy link
Collaborator Author

ronyeh commented Apr 22, 2022

Perhaps the new exmaples should be created using Factory rather than Native API

Sounds good. I think that can be a separate PR. We can eventually move the docs and examples towards Factory API.

@0xfe
Copy link
Owner

0xfe commented Apr 25, 2022

Sorry I'm being really slow here. Is this still a work in progress?

@ronyeh
Copy link
Collaborator Author

ronyeh commented Apr 25, 2022

Ah sorry for not being clear. I've tested this and believe it's good to go.

@0xfe
Copy link
Owner

0xfe commented Apr 25, 2022

Looks good, thanks Ron.

@0xfe 0xfe merged commit 87923be into 0xfe:master Apr 25, 2022
@ronyeh ronyeh deleted the fix/jsfiddle branch January 7, 2023 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rvilarl rvilarl rvilarl approved these changes

Assignees
No one assigned
Labels
4.0.2
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ronyeh @0xfe @rvilarl