-
Notifications
You must be signed in to change notification settings - Fork 45
6. Pushing changes to PyPI and the Website
Keenon Werling edited this page Nov 2, 2021
·
1 revision
You can become a core contributor of Nimble! If you have a new feature or bug fix you'd like to push to Nimble, follow these steps:
- Push your changes to a branch
- Wait a few hours for the CI tests to pass. You can monitor running tests for your commits here. CI doesn't work on PR's yet, so if you have a PR and see the tests for it fail, just ignore that.
- Once the tests pass, you're good to merge your changes into master. This will run CI tests once again.
- If you'd like to publish your changes to PyPI, all you have to do is bump the minor version (the number after the second "dot") in
VERSION.txt
like in this example commit here. You can just push this directly to master. Generally the major version (the number after the first "dot") is only bumped if something was severely broken and we're fixing it in this new version. - When that commit passes, you can push an upgraded bundle to PyPI directly from CI, by creating a "Release" for your version number. Please create a Release with a tag that matches your version number, with a "v" in front. For example, for 0.5.8, create a release with tag "v0.5.8". You can create a tag directly within the Release UI. Creating a release will trigger a "Build and Publish Wheel" action, which takes about an hour, and builds and deploys all the Python wheels to PyPI.
- Once the "Build and Publish Wheel" action completes, you're done! Anyone who runs
pip3 install nimble
(orpip3 install --upgrade nimblephysics
if they already havenimble
installed) will get your latest changes :)
Please also update the customer-facing docs and website! To do that:
- Go into the
www/
folder.www/public/
holds the raw HTML and CSS for our homepage.www/docs/
holds the source code that is used to generate our docs page. - Edit stuff.
- Run
./deploy.sh
from inside thewww/
folder. This will push your changes to the public website!
Please use your power responsibly :)