|
| 1 | +# Durable Task Protobuf Files |
| 2 | + |
| 3 | +This directory contains the protocol buffer definitions used by the Durable Task Framework Java SDK. The files in this directory are automatically downloaded and updated during the build process from the [microsoft/durabletask-protobuf](https://github.com/microsoft/durabletask-protobuf) repository. |
| 4 | + |
| 5 | +## Directory Structure |
| 6 | + |
| 7 | +- `protos/` - Contains the downloaded proto files |
| 8 | +- `PROTO_SOURCE_COMMIT_HASH` - Contains the commit hash of the latest proto file version |
| 9 | + |
| 10 | +## Auto-Update Process |
| 11 | + |
| 12 | +The proto files are automatically downloaded and updated when running Gradle builds. This is handled by the `downloadProtoFiles` task in the `client/build.gradle` file. The task: |
| 13 | + |
| 14 | +1. Downloads the latest version of `orchestrator_service.proto` |
| 15 | +2. Saves the current commit hash for tracking purposes |
| 16 | +3. Updates these files before proto compilation begins |
| 17 | + |
| 18 | +## Manual Update |
| 19 | + |
| 20 | +If you need to manually update the proto files, you can run: |
| 21 | + |
| 22 | +```bash |
| 23 | +./gradlew downloadProtoFiles |
| 24 | +``` |
| 25 | + |
| 26 | +# Durable Task Protobuf Definitions |
| 27 | + |
| 28 | +This repo contains [protocol buffer](https://developers.google.com/protocol-buffers) (protobuf) definitions |
| 29 | +used by the Durable Task framework sidecar architecture. It's recommended that Durable Task language SDKs reference |
| 30 | +the protobuf contracts in this repo via [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). |
| 31 | + |
| 32 | +## Contributing |
| 33 | + |
| 34 | +This project welcomes contributions and suggestions. Most contributions require you to agree to a |
| 35 | +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us |
| 36 | +the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. |
| 37 | + |
| 38 | +When you submit a pull request, a CLA bot will automatically determine whether you need to provide |
| 39 | +a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions |
| 40 | +provided by the bot. You will only need to do this once across all repos using our CLA. |
| 41 | + |
| 42 | +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
| 43 | +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or |
| 44 | +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. |
| 45 | + |
| 46 | +## Trademarks |
| 47 | + |
| 48 | +This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft |
| 49 | +trademarks or logos is subject to and must follow |
| 50 | +[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general). |
| 51 | +Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. |
| 52 | +Any use of third-party trademarks or logos are subject to those third-party's policies. |
0 commit comments