Skip to content

Commit 9cfdb68

Browse files
authored
Merge pull request #9950 from circleci/DOCSS-2001/fix-test-result-docs
[DOCSS-2001] test results can be directly in path directory
1 parent 483a415 commit 9cfdb68

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

docs/guides/modules/test/pages/collect-test-data.adoc

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[#introduction]
77
== Introduction
88

9-
When you run tests in CircleCI there are two ways to store your test results. You can either use xref:optimize:artifacts.adoc[artifacts] or the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` step]. Each of these methods has advantages, so the decision needs to be made for each project.
9+
When you run tests in CircleCI there are two ways to store your test results. You can either use xref:optimize:artifacts.adoc[Artifacts] or the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` step]. Each of these methods has advantages, so the decision needs to be made for each project.
1010

1111
When you save test data using the `store_test_results` step, CircleCI collects data from XML files and uses it to provide insights into your job. This page describes how to configure CircleCI to output test data as XML for some common test runners and store reports with the `store_test_results` step.
1212

@@ -18,20 +18,21 @@ Using the *`store_test_results` step* gives you access to:
1818
1919
You can also store test results as *artifacts*, which means you can look at the raw XML. Using artifacts can be useful when debugging issues with setting up your project's test results handling, for example, finding incorrectly uploaded files.
2020

21-
To see test results as build artifacts, upload them using the xref:reference:ROOT:configuration-reference.adoc#storeartifacts[`store_artifacts` step]. Storing artifacts has associated costs due to the use of storage. See the xref:optimize:persist-data.adoc#custom-storage-usage[Persisting data] page for information on how to customize storage retention periods for objects like artifacts.
21+
To see test results as build artifacts, upload them using the xref:reference:ROOT:configuration-reference.adoc#storeartifacts[`store_artifacts` Step]. Storing artifacts has associated costs due to the use of storage. See the xref:optimize:persist-data.adoc#custom-storage-usage[Persisting Data] page for information on how to customize storage retention periods for objects like artifacts.
2222

2323
TIP: You can choose to upload your test results using both `store_test_results` and `store_artifacts`.
2424

25-
Using the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` step] allows you to do the following:
25+
Using the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` Step] allows you to do the following:
2626

2727
* Upload and store test results.
2828
* Get a view of your passing/failing tests in the CircleCI web app.
2929
3030
Access test results from the *Tests tab* when viewing a job, as shown below.
3131

32+
.Test summary view
3233
image::guides:ROOT:test-summary.png[store-test-results-view]
3334

34-
Below is an example of using the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` key] in your `.circleci/config.yml`.
35+
Below is an example of using the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` Key] in your `.circleci/config.yml`.
3536

3637
[,yml]
3738
----
@@ -44,14 +45,14 @@ steps:
4445
path: test-results
4546
----
4647

47-
The `path` key is an absolute or relative path to your `working_directory` containing subdirectories of JUnit XML test metadata files, or the path of a single file containing all test results.
48+
The `path` key is an absolute or relative path to your `working_directory`. It can contain JUnit XML test metadata files directly in the directory, in subdirectories, or point to a single file containing all test results.
4849

4950
CAUTION: Make sure that your `path` value is not a hidden folder. For example, `.my_hidden_directory` would be an invalid format.
5051

5152
[#viewing-storage-usage]
5253
== Viewing storage usage
5354

54-
For information on viewing your storage usage, and calculating your monthly storage overage costs, see the xref:optimize:persist-data.adoc#managing-network-and-storage-usage[Persisting data] guide.
55+
For information on viewing your storage usage, and calculating your monthly storage overage costs, see the xref:optimize:persist-data.adoc#managing-network-and-storage-usage[Persisting Data] guide.
5556

5657
[#test-insights]
5758
== Test Insights
@@ -84,7 +85,7 @@ gem 'minitest-ci'
8485
8586
* Django should be configured using the link:https://github.com/django-nose/django-nose[`django-nose`] test runner.
8687
87-
For detailed information on how to test your iOS applications, refer to the xref:testing-ios.adoc[Testing iOS applications] page.
88+
For detailed information on how to test your iOS applications, refer to the xref:testing-ios.adoc[Testing iOS Applications] page.
8889

8990
[#test-runner-examples-by-language]
9091
== Test runner examples by language

styles/circleci-docs/XrefTitleCase.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ script: |
3131
continue
3232
}
3333
34+
// Skip if link text starts with a backtick (code references)
35+
trimmed_link := text.trim_space(link_text)
36+
if text.re_match("^`", trimmed_link) {
37+
continue
38+
}
39+
3440
// Split into words
3541
words := text.split(link_text, " ")
3642
has_error := false
@@ -59,6 +65,12 @@ script: |
5965
if is_exception {
6066
continue
6167
}
68+
69+
// Skip iOS (capitalized) - only allow capitalized version
70+
if clean_word == "iOS" {
71+
continue
72+
}
73+
6274
// Get first character
6375
first_char := text.substr(clean_word, 0, 1)
6476
is_capitalized := text.re_match("[A-Z]", first_char)

0 commit comments

Comments
 (0)