You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 8582ba4
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ The test suite compliance dashboard is comprised of two parts:
16
16
If you are an array library maintainer wanting to report Array API test suite results, you need to do two things:
17
17
18
18
1. Set up a public endpoint from which your test suite results can be regularly retrieved. This can be a GitHub workflow artifact, a public URL, or some other supported endpoint mechanism.
19
-
2. Register your library's public endpoint(s) with this repository. See **Registration** below.
19
+
2. Register your library's public endpoint(s) with this repository. See [**Registration**](#registration) below.
20
20
21
21
For array libraries already using GitHub workflows for running their test suites (including against the Array API test suite), see the [demonstration](https://github.com/data-apis/array-api-tests-compliance-data/blob/main/.github/workflows/demo.yml) GitHub workflow for how to run the test suite and generate a valid test suite report JSON.
22
22
@@ -25,6 +25,8 @@ For array libraries already using GitHub workflows for running their test suites
25
25
26
26
* * *
27
27
28
+
<aname="registration"></a>
29
+
28
30
## Registration
29
31
30
32
If you are the maintainer of an array library adopting the Array API standard and would like to submit test suite results, you're in the right place!
@@ -74,7 +76,7 @@ To add your library, please do the following:
74
76
75
77
4. Open a PR against this repository which adds the registration entry. Once merged, automated workflows will begin monitoring the registration endpoint(s).
76
78
77
-
5. Set up your library to begin publishing test suite results. See below concerning **Test Suite Artifacts**.
79
+
5. Set up your library to begin publishing test suite results. See below concerning [**Test Suite Artifacts**](#test-suite-artifacts).
78
80
79
81
### Examples
80
82
@@ -157,7 +159,7 @@ Once the raw report is generated, you need to augment the generated JSON with ad
157
159
158
160
-**schema**: report schema version (e.g., `v1`).
159
161
160
-
-**name**: array library name. This **must** match the registration `report_name`, as discussed above.
162
+
-**name**: array library name. This **must** match the registration `report_name`, as discussed above for registering an array library (see [**Registration**](#registration)).
161
163
162
164
-**version**: array library version. This is the version of your library against which the test suite ran.
0 commit comments