Skip to content

Commit 59c902a

Browse files
authored
Adding instructions for sharing this repo (#4)
* updating readme for new instructions * formatting * still strange formatting * more formatting
1 parent 8968984 commit 59c902a

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,36 @@
11
# Azure Functions Languge Worker Protobuf
22

3-
This repository contains the protobuf definition file which defines the gRPC service which is used between the Azure WebJobs Script host and the Azure Functions language workers.
3+
This repository contains the protobuf definition file which defines the gRPC service which is used between the Azure WebJobs Script host and the Azure Functions language workers. This repo is shared across many repos in many languages (for each worker) by using git commands.
44

5-
Learn more about Azure Function's projects on the [meta](https://github.com/azure/azure-functions) repo.
5+
To use this repo in Azure Functions language workers, follow steps below to add this repo as a subtree (*Adding This Repo*). If this repo is already embedded in a language worker repo, follow the steps to update the consumed file (*Pulling Updates*).
66

7-
## Using the protobufs
7+
Learn more about Azure Function's projects on the [meta](https://github.com/azure/azure-functions) repo.
88

9-
Download the contents from the latest (or specific) release. Release will follow semver guidelines.
9+
## Adding This Repo
10+
11+
From within the Azure Functions language worker repo:
12+
1. Define remote branch for cleaner git commands
13+
- `git remote add proto-file https://github.com/azure/azure-functions-language-worker-protobuf.git`
14+
- `git fetch proto-file`
15+
2. Index contents of azure-functions-worker-protobuf to language worker repo
16+
- `git read-tree --prefix=<path in language worker repo> -u proto-file/<version branch>`
17+
3. Add new path in language worker repo to .gitignore file
18+
- In .gitignore, add path in language worker repo
19+
4. Finalize with commit
20+
- `git commit -m “Added subtree from https://github.com/azure/azure-functions-language-worker-protobuf. Branch: <version branch>. Commit: <latest protobuf commit hash>”`
21+
- `git push`
22+
23+
## Pulling Updates
24+
25+
From within the Azure Functions language worker repo:
26+
1. Define remote branch for cleaner git commands
27+
- `git remote add proto-file https://github.com/mhoeger/azure-functions-language-worker-protobuf.git`
28+
- `git fetch proto-file`
29+
2. Merge updates
30+
- `git merge -X subtree=<path in language worker repo> --squash proto-file/<version branch>`
31+
3. Finalize with commit
32+
- `git commit -m "Updated subtree from https://github.com/azure/azure-functions-language-worker-protobuf. Branch: <version branch>. Commit: <latest protobuf commit hash>”`
33+
- `git push`
1034

1135
## Contributing
1236

0 commit comments

Comments
 (0)