blender/blender-developer-docs
7
8
Fork 38
Code Issues 3 Pull Requests 6 Activity

Update "Commiting Test Data" section to include build bot testing #77

Merged
Alaska merged 8 commits from Alaska/blender-developer-docs:test-updates-guide into main 2024-10-07 14:56:31 +02:00
Conversation 2 Commits 8 Files Changed 1 +19 -8
1 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit b71431238f - Show all commits

27
docs/handbook/testing/setup.md
View File

@ -144,25 +144,36 @@ Ensure submodules are up to date.
make update
```
Commit test files to the main branch of the test data repository.
Commit new or modified test files to a new branch of the test data repository.
``` bash
cd tests/data
git checkout main
.. make any changes ..
git checkout -B add-x-tests
.. make your changes ..
git commit testfile1 testfile2
git push origin add-x-tests
```
Commit changes in the Blender repository, including the updated `tests/data` submodule hash.
Commit changes to your fork of the Blender repository, including the updated
`tests/data` submodule hash, and create a pull request.
``` bash
cd ../..
git checkout -B add-x-tests
git commit sourcefile1 sourcefile2 tests/data
git push me
.. then create a pull request from this branch ..
Alaska marked this conversation as resolved Outdated
Weizhen Huang commented 2024-10-02 13:02:48 +02:00
Outdated
Review
Copy Link

This should not be part of the code block, but a paragraph, preferably linked to https://developer.blender.org/docs/handbook/contributing/pull_requests/#create-a-pull-request

This should not be part of the code block, but a paragraph, preferably linked to https://developer.blender.org/docs/handbook/contributing/pull_requests/#create-a-pull-request
```
Check everything is ok, and push to both repositories.
Ensure your tests pass on the build bot commenting `@blender-bot build`,
Alaska marked this conversation as resolved Outdated
Weizhen Huang commented 2024-10-02 13:05:14 +02:00
Outdated
Review
Copy Link

Should be in the same paragraph as "create a pull request". We can also add a link to the bot https://projects.blender.org/infrastructure/blender-bot/src/branch/main/README.md

Should be in the same paragraph as "create a pull request". We can also add a link to the bot https://projects.blender.org/infrastructure/blender-bot/src/branch/main/README.md
or `@blender-bot build +gpu` to also run GPU tests (these aren't tested
regularly, so some GPU tests you havn't modified may fail), in your pull request.
If the tests pass, then push your changes in the test data repo to the
main branch, update your branch of the Blender repo to point to the updated tests,
then push your Blender chages to the main branch of the Blender repo.
``` bash
cd tests/data
git push origin main
cd ../..
git push origin main
TODO: Add commands?
I personally haven't done merging/squishing of branches into main so I'm not sure the correct approach here.
Sergey Sharybin commented 2024-10-02 11:35:56 +02:00
Outdated
Review
Copy Link

There should be something like

git checkout main
git merge --ff-only add-x-tests
git push origin main

And then land the PR from the Gita interface.
Maybe would be good to have @weizhen, @Sirgienko, or @LukasStockner have a look. They were working with tests more recently than me.

There should be something like ``` git checkout main git merge --ff-only add-x-tests git push origin main ``` And then land the PR from the Gita interface. Maybe would be good to have @weizhen, @Sirgienko, or @LukasStockner have a look. They were working with tests more recently than me.
```