Skip to content

Commit 12657b9

Browse files
committed
Document report contents with column name followed by description
In the interest of minimizing column width, some of the report column names are a bit terse and require explanation but it's important to still use the column name in the documentation. [skip ci]
1 parent 36a7c6d commit 12657b9

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -109,24 +109,26 @@ Pass some parameters from .travis.yml to the script. `build_sketch` will echo th
109109
##### `display_report`
110110
Echo a tab separated report of all verification results to the log. The report is located at `$HOME/report.txt`. Note that Travis CI runs each build of the job in a separate virtual machine so if you have multiple jobs you will have multiple reports. The only way I have found to generate a single report for all tests is to run them as a single job. This means not setting multiple matrix environment variables in the `env` array. See https://docs.travis-ci.com/user/environment-variables. The report consists of:
111111
- Build timestamp
112-
- Travis CI build number
113-
- Travis CI job number
114-
- Travis CI job URL
115-
- Travis CI build trigger
116-
- Allow Travis CI job failure
117-
- Pull request number
118-
- Branch
119-
- Commit hash of the build
120-
- Commit range
121-
- Commit subject
112+
- Build - The Travis CI build number.
113+
- Job - Travis CI job number
114+
- Job URL - The URL of the Travis CI job log.
115+
- Build Trigger - The cause of this Travis CI build. Values are `push`, `pull_request`, `api`, `cron`.
116+
- Allow Job Failure - Whether the Travis CI configuration was set to allow the failure of this job without failing the build.
117+
- PR# - Pull request number (if build was triggered by a pull request).
118+
- Branch - The branch of the repository that was built.
119+
- Commit - Commit hash of the build.
120+
- Commit range - The range of commits that were included in the push or pull request.
121+
- Commit Message - First line of the commit message
122122
- Sketch filename
123123
- Board ID
124124
- IDE version
125-
- Program storage usage
126-
- Dynamic memory usage by global variables (not available for some boards)
127-
- Number of warnings
128-
- Sketch verification allowed to fail
129-
- Sketch verification exit code
125+
- Program Storage (bytes) - Program storage usage of the compiled sketch.
126+
- Dynamic Memory (bytes) - Dynamic memory usage by global variables in the compiled sketch (not available for some boards).
127+
- # Warnings - Number of warnings reported by the compiler during the sketch compilation.
128+
- Allow Failure - Whether the sketch verification was allowed to fail (set by the `allowFail` argument of `build_sketch`).
129+
- Exit Code - Exit code returned by arduino after the sketch verification.
130+
- # Board Issues - The number of board issues detected.
131+
- Board Issue - Short description of the last board issue detected.
130132

131133
##### `publish_report_to_repository REPORT_GITHUB_TOKEN repositoryURL reportBranch reportFolder doLinkComment`
132134
Add the report to a repository. See the [instructions for publishing job reports](publishing-job-reports) for details.

0 commit comments

Comments
 (0)