Skip to content

Commit 60d1108

Browse files
committed
Update README
- how to trigger ITs for fork PRs - auto-merge for dependabot PRs
1 parent aa99c11 commit 60d1108

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Follow these steps to make a contribution to the project:
113113
ginkgo --race --skip-package=integration --cover -v -r ./...
114114
```
115115
- If you added or modified integration tests, to run them locally, follow the instructions in the provider-specific README (see [Providers](#providers) section)
116-
- **Note:** Integration tests require access to cloud provider credentials and cannot run on PRs from forks. They will run automatically when a maintainer merges your PR to main.
116+
- **Note:** Integration tests require access to cloud provider credentials and don't run on PRs from forks. Maintainers can trigger the integration tests.
117117
- Push changes to your fork
118118
``` bash
119119
git add .
@@ -122,11 +122,18 @@ Follow these steps to make a contribution to the project:
122122
```
123123
- Create a GitHub pull request, selecting `main` as the target branch
124124

125+
### Integration tests for fork PRs
126+
127+
After reviewing a PR, maintainers can run integration tests for fork PRs by adding a comment `/run-integration` to the PR.
128+
129+
> [!WARNING]
130+
> @maintainers: Review the PR carefully before running the integration tests to avoid leaking of credentials.
131+
125132
## Dependency Updates
126133

127134
This project uses [Dependabot](https://docs.github.com/en/code-security/dependabot) to keep dependencies up to date. Dependencies are grouped (e.g., AWS SDK, Azure SDK, Google Cloud, testing tools) to reduce PR noise.
128135

129-
**Integration tests on Dependabot PRs:** Integration tests are skipped for Dependabot PRs since they don't have access to secrets. If needed, maintainers can manually trigger the integration tests via `workflow_dispatch` before merging. Integration tests will also run automatically after merging to main.
136+
Dependabot PRs are merged automatically if they pass all required checks (tests and integration tests).
130137

131138
## Releases
132139

0 commit comments

Comments
 (0)