Skip to content

Commit 3304559

Browse files
authored
[PLT-0] Update workflow docs (#1564)
1 parent 76c981b commit 3304559

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,19 @@ Thank you for expressing your interest in contributing! To ensure that your cont
3333

3434
Your contributions will be released as soon as it is approved and merged into the `develop` branch. Please consult the [Labelbox](https://docs.labelbox.com/docs/contacting-customer-support) team for if you need a more specific timeframe of when your contributions may be released.
3535

36+
## Github Workflows
37+
38+
![workflow](./docs/github-workflow.svg)
39+
40+
The above describes the workflows that currently exist.
41+
42+
* Github Branch Workflow
43+
* When you push to a branch, it will create a build of the SDK that runs tests against **staging**. It will publish the build to `test.pypi.org` which can be downloaded for testing. Also, a docker image is built which can be used for testing as it has the SDK installed.
44+
* Github Develop Workflow
45+
* When you push to a `develop` (main branch), it will create a build of the SDK that runs tests against **staging**. It will publish the build to `test.pypi.org` which can be downloaded for testing. Also, a docker image is built which can be used for testing as it has the SDK installed. This docker image is tagged with `develop`.
46+
* Github Publish Workflow
47+
* When you run the publish workflow, it will create a build of the SDK that runs tests against **production**. It will publish the build to `pypi.org` which is what consumers of the SDK will normally use. Also, a docker image is built which can be used for testing as it has the SDK installed. This docker image is tagged with `latest`.
48+
3649
## General Prerequisites
3750

3851
[Rye](https://rye-up.com/) must be installed before contributing to the repository as it is the tool used to managed the repository.

0 commit comments

Comments
 (0)