vis.js is a dynamic, browser-based visualization library
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

94 lines
2.4 KiB

10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
  1. # How to publish vis.js
  2. This document describes how to publish vis.js.
  3. ## Build
  4. - Change the version number of the library in both `package.json` and `bower.json`.
  5. - Open `HISTORY.md`, write down the changes, version number, and release date.
  6. - Build the library by running:
  7. npm update
  8. npm run build
  9. This generates the vis.js library in the folder `./dist`.
  10. ## Test
  11. - Test the library:
  12. npm test
  13. - Open some of the example in your browser and visually check if it works as expected.
  14. ## Commit
  15. - Commit the changes to the `develop` branch.
  16. - Merge the `develop` branch into the `master` branch.
  17. - Push the branches to github
  18. - Create a version tag (with the new version number) and push it to github:
  19. git tag v0.3.0
  20. git push --tags
  21. ## Publish
  22. - Publish at npm:
  23. npm publish
  24. - Test the published library:
  25. - Go to a temp directory
  26. - Install the library from npm:
  27. npm install vis
  28. Verify if it installs the just released version, and verify if it works.
  29. - Install the library via bower:
  30. bower install vis
  31. Verify if it installs the just released version, and verify if it works.
  32. - Publish the library at cdnjs.org
  33. - clone the cdnjs project
  34. - pull changes: `git pull upstream`
  35. - add the new version of the library under /ajax/libs/vis/
  36. - add new folder /x.y.z/ with the new library
  37. - update the version number in package.json
  38. - test the library by running `npm test`
  39. - then do a pull request with as title "[author] Update vis.js to x.y.z"
  40. (with correct version).
  41. ## Update website
  42. - Copy the `dist` folder from the `master` branch to the `github-pages` branch.
  43. - Copy the `examples` folder from the `master` branch to the `github-pages` branch.
  44. - Copy the `docs` folder from the `master` branch to the `github-pages` branch.
  45. - Create a packaged version of vis.js. Go to the `master` branch and run:
  46. zip vis.zip dist docs examples README.md HISTORY.md LICENSE NOTICE -r
  47. - Move the created zip file `vis.zip` to the `download` folder in the
  48. `github-pages` branch. TODO: this should be automated.
  49. - Go to the `github-pages` branch and run the following script:
  50. node updateversion.js
  51. - Commit the changes in the `gh-pages` branch.
  52. ## Prepare next version
  53. - Switch to the `develop` branch.
  54. - Change version numbers in `package.json` and `bower.json` to a snapshot
  55. version like `0.4.0-SNAPSHOT`.