diff --git a/docs/handbook/testing/setup.md b/docs/handbook/testing/setup.md index a17dfcfb..a606c32a 100644 --- a/docs/handbook/testing/setup.md +++ b/docs/handbook/testing/setup.md @@ -148,7 +148,7 @@ Commit test files to the main branch of the test data repository. ``` bash cd tests/data git checkout main -.. make any changes .. +.. make your changes .. git commit testfile1 testfile2 ``` @@ -166,3 +166,45 @@ cd ../.. git push origin main ``` + +> NOTE: **Make sure the tests pass before committing to main** +> +> You should run your tests to make sure they pass before commiting them to main. +This can be done [locally](#running-tests), or using [Blender Bot](https://projects.blender.org/infrastructure/blender-bot/src/branch/main/README.md) from Gitea +to ensure they pass on all platforms. +The steps for testing on the build bot are as follows: +> +> Commit changes in the `tests/data` repository to a new branch rather than main. +``` bash +cd tests/data +git checkout -B add-x-tests +.. make your changes .. +git commit testfile1 testfile2 +git push origin add-x-tests +``` +> +> Commit the new `tests/data` submodule hash to your fork of the Blender repository. +``` bash +cd ../.. +git checkout -B add-x-tests-blender +git commit tests/data +git push me add-x-tests-blender +``` +> [Create a pull request](/docs/handbook/contributing/pull_requests/#create-a-pull-request) from the +link printed in the console, +and comment `@blender-bot build` to get the build bot to test the changes. Alternatively, +`@blender-bot build +gpu` can be used to trigger additional GPU tests (these aren't tested regularly, +so some GPU tests you haven't modified may fail). +> +> If the tests pass, then you can push your changes in the `tests/data` +repository to the main branch. +``` bash +cd tests/data +git checkout main +# Use --ff-only to keep the submodule hash unchanged. +git merge --ff-only add-x-tests +git push origin main +``` +> +> From the Gitea interface, merge the pull request you just created in the Blender repository. +