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
soraphis/issue418
unity-atoms/PUBLISHING.md
Adam Ramberg 2c46746a34
Remove generated API docs (#411) 
* * Remove generateDocs.js
* Update PUBLISHING.md
* Remove generated md files
* Remove all package.json deps in root since they are not needed anymore
* Remove all refs to api folder in website
* Replaced header link to API with link to the first tutorial

* Tutorial -> Tutorials

* Clean up
2023-07-22 00:34:12 +02:00

1022 B
Raw Permalink 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.
  • [] 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.