From 08923e5aaa65fe4a3ddc7f3349a53ee2cf576d99 Mon Sep 17 00:00:00 2001 From: Marcus Noble Date: Thu, 27 Jun 2024 15:28:04 +0100 Subject: [PATCH] Added docs about running the E2E tests against PRs (#1299) Signed-off-by: Marcus Noble --- .github/pull_request_template.md | 14 ++++++++++++++ README.md | 17 +++++++++++++++-- 2 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..a54b16ea4 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,14 @@ +### What this PR does + + +### Checklist + +- [ ] Update changelog in CHANGELOG.md for SDK changes. + +### Triggering e2e tests + +To trigger the E2E test for each new Release added in this PR add a comment with the following: + +`/run releases-test-suites` + +For more details see the [README.md](/README.md#running-tests-against-prs) diff --git a/README.md b/README.md index 5f1749fe9..0662a8d74 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ to all Giant Swarm installations. - [v19.0.1](https://github.com/giantswarm/releases/tree/master/aws/v19.0.1) - [v19.0.0](https://github.com/giantswarm/releases/tree/master/aws/v19.0.0) - [v19.0.0-beta1](https://github.com/giantswarm/releases/tree/master/aws/archived/v19.0.0-beta1) - - [v19.0.0-alpha1](https://github.com/giantswarm/releases/tree/master/aws/archived/v19.0.0-alpha1) + - [v19.0.0-alpha1](https://github.com/giantswarm/releases/tree/master/aws/archived/v19.0.0-alpha1) - v18 - v18.0 - [v18.4.2](https://github.com/giantswarm/releases/tree/master/aws/v18.4.2) @@ -240,7 +240,7 @@ to all Giant Swarm installations. - v18.0 - [v18.0.1](https://github.com/giantswarm/releases/tree/master/azure/archived/v18.0.1) - [v18.0.0](https://github.com/giantswarm/releases/tree/master/azure/archived/v18.0.0) - + - v17 - v17.2 - [v17.2.0](https://github.com/giantswarm/releases/tree/master/azure/archived/v17.2.0) @@ -422,3 +422,16 @@ to all Giant Swarm installations. - [v8.1.0](https://github.com/giantswarm/releases/tree/master/kvm/archived/v8.1.0) - v8.0 - [v8.0.0](https://github.com/giantswarm/releases/tree/master/kvm/archived/v8.0.0) + +# Running tests against PRs + +To trigger the E2E test for each new Release added in a PR add a comment with the following: + +`/run releases-test-suites` + +This will automatically trigger tests for all new releases detected in the PR and will run them against the appropriate `standard` test suite for the provider. + +If you need to run tests for a specific Release (from the PR) or a different test suite you can do so with the two following, optional parameters: + +* `TARGET_SUITES` - a comma separated list of test suites to trigger (e.g. `./providers/capa/standard`) +* `TARGET_RELEASES` - a comma separates list of Releases to trigger from the PR (e.g. `aws-25.0.0-example.1`)