Skip to content

Commit 5beddbd

Browse files
authored
Add GitHub actions setup instructions
1 parent 3318c47 commit 5beddbd

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,17 @@ For example, if the application created a pipeline object `GstPipeline* pipeline
337337

338338
<br>
339339

340+
### CI Testing
341+
342+
GitHub actions will run tests and builds for every pull request.
343+
344+
To setup the CI in your environment, follow https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services to setup the IAM permissions and role for your GitHub repository.
345+
346+
Afterwards, go to your repository settings and add the following repository secrets:
347+
* Key: `AWS_ROLE_TO_ASSUME` -- Assume role ARN
348+
* Key: `AWS_REGION` -- Region to use (e.g. `us-west-2`)
349+
* Key: `AWS_ROLE_SESSION_NAME` -- Optional. This name appears in AWS CloudTrail logs for entries associated with this session.
350+
340351
## Development
341352

342353
The repository is using develop branch as the aggregation and all of the feature development is done in appropriate feature branches. The PRs (Pull Requests) are cut on a feature branch and once approved with all the checks passed, they can be merged by a click of a button on the PR tool. The master branch should always be build-able and all the tests should be passing. We are welcoming any contribution to the code base. The master branch contains our most recent release cycle from develop.

0 commit comments

Comments
 (0)