Skip to content

Commit

Permalink
Update contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cgokmen committed Oct 1, 2024
1 parent ca071a7 commit 7083def
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/miscellaneous/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,18 @@ The BEHAVIOR suite has continuous integration running via Github Actions in cont
* Docs builds are run on the behavior-website repo along with the rest of the website.
* When GitHub releases are created, a source distribution will be packed and shipped on PyPI by a hosted runner

For more information about the workflows and runners, please reach out on our Discord channel.
For more information about the workflows and runners, please reach out on our Discord channel.

## **Release Process**
At the time of each release, we follow the below process:

1. Update the version of OmniGibson in the pyproject.toml and __init__.py files.
2. Add a release note on the README.md file
3. Push to `og-develop`
4. Wait for all tests to finish, confirm they are passing, confirm docs build on behavior-website
5. Push `og-develop` to `main`
6. Click on create release on GitHub, tag the version starting with the letter `v`
7. Create release notes. You can use the automated release notes but edit to include the important info.
8. Create the release.
9. Wait for docker and PyPI releases to finish, confirm success
10. Announce on Discord, user channels.

0 comments on commit 7083def

Please sign in to comment.