Add docs for Circleci rerun failed tests feature #146
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3v0k4
approved these changes
Dec 4, 2023
docusaurus/docs/ruby/circleci.md
Outdated
| # highlight-start | ||
| # Use circleci CLI to find out if we need to run all tests or rerun failed tests | ||
| # We are telling circleci to split the tests across 1 node to get the full list of all tests for consideration. We leave the splitting to Knapsack Pro. | ||
| circleci tests glob "spec/**/*_spec.rb" | circleci tests run --index 0 --total 1 --command ">/tmp/tests_to_run.txt xargs echo" --verbose > /tmp/tests_to_run.txt |
There was a problem hiding this comment.
I think that with -n1 you won't need the sed later:
Suggested change
| circleci tests glob "spec/**/*_spec.rb" | circleci tests run --index 0 --total 1 --command ">/tmp/tests_to_run.txt xargs echo" --verbose > /tmp/tests_to_run.txt | |
| circleci tests glob "spec/**/*_spec.rb" | circleci tests run --index 0 --total 1 --command ">/tmp/tests_to_run.txt xargs -n1 echo" --verbose > /tmp/tests_to_run.txt |
docusaurus/docs/ruby/circleci.md
Outdated
| sed -i 's/ /\n/g' /tmp/tests_to_run.txt | ||
|
|
||
| # tell Knapsack Pro to run only tests from the file (and still use Knapsack Pro Queue Mode magic) | ||
| if [[ -s "/tmp/tests_to_run.txt" ]]; then |
There was a problem hiding this comment.
This is checking if the file exists and is non-empty. Should that be always the case?
What if we remove the if and let Knapsack Pro raise an error?
docusaurus/docs/ruby/circleci.md
Outdated
Comment on lines
106
to
107
| - We use [`KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE`](reference.md#knapsack_pro_test_file_list_source_file) to feed Knapsack Pro with a list of test files to run. | ||
| - Optionally, you can use [`KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES`](split-by-test-examples.md) to split slow test files by test examples automatically. |
There was a problem hiding this comment.
I'd either mention both in the snippet, or here. Currently, KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES is present in both.
If the links in the snippet cannot be made clickable, I'd leave them both down here.
Suggested change
| - We use [`KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE`](reference.md#knapsack_pro_test_file_list_source_file) to feed Knapsack Pro with a list of test files to run. | |
| - Optionally, you can use [`KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES`](split-by-test-examples.md) to split slow test files by test examples automatically. | |
| The snippet above uses: | |
| - [`KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES`] to split tests by examples | |
| - [`KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE`] to specify what tests to run |
Co-authored-by: Riccardo <riccardo.odone@gmail.com>
Co-authored-by: Riccardo <riccardo.odone@gmail.com>
Co-authored-by: Riccardo <riccardo.odone@gmail.com>
Co-authored-by: Riccardo <riccardo.odone@gmail.com>
Co-authored-by: Riccardo <riccardo.odone@gmail.com>
Co-authored-by: Riccardo <riccardo.odone@gmail.com>
…docs.knapsackpro.com into circleci-rerun-failed-tests
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
story
https://trello.com/c/XFXyRYPu