Skip to content

Commit 5df6fcf

Browse files
authored
docs: add contribute and release process to readme (#74)
1 parent 5f8bc22 commit 5df6fcf

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,28 @@ Note that the `DynamoDB` operations are _upsert_, so if an issue happens, the la
4646
## Issues
4747

4848
Please report issues in the [elastic-ipfs/elastic-ipfs repo](https://github.com/elastic-ipfs/elastic-ipfs/issues).
49+
50+
## Contribute and release process
51+
52+
This is the process to contribute and get a new build deployed:
53+
54+
- Create a Pull Request with the intended change
55+
- Get a review from one of the team members
56+
- Deploy the Pull Request branch into a dev build using Github Action `Dev | Build And Deploy` and selecting branch
57+
- Unit test Dev build lambda in [AWS Console](https://us-west-2.console.aws.amazon.com/lambda/home?region=us-west-2#/functions/dev-ep-indexer?tab=testing) with a given Event JSON (example below). Validate lambda output and the dynamoDB tables used by this lambda.
58+
- Run [`bitswap-e2e-tests`](https://github.com/elastic-ipfs/bitswap-e2e-tests/actions/workflows/dispatch-regressions.yaml) for the `Dev` build.
59+
- Merge Pull Request after being approved
60+
- Staging release will be automatically created
61+
- Production release will need to be authorized by one of the admins of the repo.
62+
63+
For Dev build lambda unit test, you can use Event JSON:
64+
65+
```json
66+
{
67+
"Records": [
68+
{
69+
"body": "us-east-2/dotstorage-dev-0/100KB.car"
70+
}
71+
]
72+
}
73+
```

0 commit comments

Comments
 (0)