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.

88 lines
2.2 KiB

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 prune
  8. npm update
  9. npm run build
  10. This generates the vis.js library in the folder `./dist`.
  11. ## Test
  12. - Test the library:
  13. npm test
  14. - Open some of the examples in your browser and visually check if it works as expected.
  15. ## Commit
  16. - Commit the changes to the `develop` branch.
  17. - Merge the `develop` branch into the `master` branch.
  18. - Push the branches to github
  19. - Create a version tag (with the new version number) and push it to github:
  20. git tag v3.1.0
  21. git push --tags
  22. ## Publish
  23. - Publish at npm:
  24. npm publish
  25. - Test the published library:
  26. - Go to a temp directory
  27. - Install the library from npm:
  28. npm install vis
  29. Verify if it installs the just released version, and verify if it works.
  30. - Install the library via bower:
  31. bower install vis
  32. Verify if it installs the just released version, and verify if it works.
  33. - Verify within a day or so whether vis.js is updated on http://cdnjs.com/
  34. ## Update website
  35. - Copy the `dist` folder from the `master` branch to the `github-pages` branch.
  36. - Copy the `docs` folder from the `master` branch to the `github-pages` branch.
  37. - Copy the `examples` folder from the `master` branch to the `github-pages` branch.
  38. - Create a packaged version of vis.js. Go to the `master` branch and run:
  39. zip vis.zip dist docs examples README.md HISTORY.md CONTRIBUTING.md LICENSE* NOTICE -r
  40. - Move the created zip file `vis.zip` to the `download` folder in the
  41. `github-pages` branch. TODO: this should be automated.
  42. - Check if there are new or updated examples, and update the gallery screenshots
  43. accordingly.
  44. - Update the library version number in the index.html page.
  45. - Update the CDN links at the download section of index.html AND the CDN link at the top.
  46. - Commit the changes in the `gh-pages` branch.
  47. ## Prepare next version
  48. - Switch to the `develop` branch.
  49. - Change version numbers in `package.json` and `bower.json` to a snapshot
  50. version like `0.4.0-SNAPSHOT`.