Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 0 additions & 56 deletions .github/workflows/stats-pr.yml

This file was deleted.

7 changes: 0 additions & 7 deletions .github/workflows/test-lp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,3 @@ jobs:
- name: Check if maintenance is turned off
if: env.MAINTENANCE == 'off' && success()
run: echo "Maintenance is turned off for one or more files"
# Only upload artifact if maintenance is on
- name: Upload stats artifact
uses: actions/upload-artifact@v4
if: success() && env.MAINTENANCE == 'on'
with:
name: stats_current_test_info
path: data/stats_current_test_info.yml
4 changes: 2 additions & 2 deletions .github/workflows/weekly_stats_update.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Result: updated files content/stats/stats_weekly_data.yml content/stats/stats_current_test_info.yml
# Result: updated file data/stats_weekly_data.yml
# Will appear in learn.arm.com/stats

name: Stats file weekly update
Expand Down Expand Up @@ -57,7 +57,7 @@ jobs:
# Commit updated files in a new PR
- name: Commit updated stats files to repository
run: |
git add data/stats_weekly_data.yml data/stats_current_test_info.yml
git add data/stats_weekly_data.yml
# Push and commit only if changes to commit; if not, say so and end.
git commit -m 'automatic update of stats files' && git push origin main || echo "No changes to commit"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -242,38 +242,6 @@ The framework will print information about any errors to the console. To display
./tools/maintenance.py -i content/install-guides/mytool.md --debug
```


### Saving the results

If you want the results to be saved, add the `--stats-report` flag to the command. This will update a statistics file `stats_current_test_info.yml`, which publishes the result to the website. In order to do that, the Learning Path or Install Guide needs to exist as an entry in the statistics file. Find the category for your content. If it's an Install Guide, the name will be that of the .md file without the extension. If it's a Learning Path, you will use the name of the directory. For example:

```
install-guides:
mytool:
readable_title: My Tool
tests_and_status:
- ubuntu:latest: passed
microcontrollers:
my-new-learning-path:
readable_title: My new Learning Path
tests_and_status:
- ubuntu:latest: passed
```

```bash
./tools/maintenance.py -i content/install-guides/mytool.md --stats-report
```

```yaml
tests_and_status:
- ubuntu:latest: passed
- fedora:latest: failed
```

The field `tests_and_status` is a list that indicated whether all tests passed for a corresponding Docker container image or if at least one test failed.

In the example above, the summary indicates that for this Learning Path all tests passed for the image `ubuntu:latest` but at least one test failed for the image `fedora:latest`. More information about the failures can be found in the console.

## Advanced usage for embedded development
### Using the Corstone-300 FVP

Expand Down
206 changes: 0 additions & 206 deletions data/stats_current_test_info.yml

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
- partial general-formatting/github-links.html
- partial navigation/content-navigation-mobile.html
- partial general-formatting/external-link.html
- partial test-maintenance/test-maintenance.html
- partial general-formatting/feedback.html
- partial general-formatting/feedback.html
*/}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,16 +145,6 @@ <h2 id="about-marker">{{$page_h2}}</h2>
{{end}}
</td>
</tr>
{{ if .Params.test_maintenance}}
<tr>
<td class="td-metadata-key">
Test status:
</td>
<td class="td-metadata-value">
{{ partial "test-maintenance/test-maintenance" . }}
</td>
</tr>
{{end}}
</table>
</div>
<!-- RIGHT TABLE, mobile -->
Expand Down Expand Up @@ -199,18 +189,6 @@ <h2 id="about-marker">{{$page_h2}}</h2>
{{end}}
</td>
</tr>
{{ if .Params.test_maintenance}}
<tr>
<td class="td-metadata-key width-max-content">
Test status:
</td>
</tr>
<tr>
<td class="td-metadata-value">
{{ partial "test-maintenance/test-maintenance" . }}
</td>
</tr>
{{end}}
</table>
</div>
</div>
Expand Down
Loading