caleb-brown/unity-atoms
1
0
Fork 0
mirror of https://github.com/unity-atoms/unity-atoms.git synced 2025-01-21 23:58:49 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
3aa06a70a1
unity-atoms/PUBLISHING.md
Miika Lönnqvist c7136d2937
Updated documentation and tutorials (#267) 
Some tutorials now have animation in them to give a clearer explanation of how things work. Added a short tutorial about creating Atoms with the new Search function. Documentation about installation has also changed.
2021-06-14 20:32:52 +02:00

1.1 KiB
Raw Blame History

Publishing

Here is a check list for publishing a new version:

  • [] Checkout the canary branch and make sure CHANGELOG.md is up to date.
  • [] Update the version number in all package.json files (on the root and in all the Packages/<PackageName>/package.json)
  • [] Update the root README.md file with the correct version. Also update the version in docs/introduction/installation.md.
  • [] From the root run npm run generate:docs to make sure all API documentation is up to date.
  • [] Commit and push your changes to the canary branch.
  • [] Merge the canary branch into the master branch.
  • [] Publish a new version of the website.
    • [] Go (via the terminal) to the website folder.
    • [] Run npm start to test and see that it runs as expected.
    • [] Run GIT_USER=<your-username> \ CURRENT_BRANCH=master \ npm run publish-gh-pages to publish the website.
  • [] Create a new release under releases on the Github repo.
  • [] From the root run npm run publish:all. This is only possible for me (Adam Ramberg) at the moment. Will need to look into a solution for this.