From 781493a7aeac91298fafe53c5671043e83021777 Mon Sep 17 00:00:00 2001 From: grdddj Date: Thu, 27 Jul 2023 11:03:10 +0200 Subject: [PATCH] chore(ci): regenerate docs [no changelog] --- docs/ci/jobs.md | 73 ++++++++++++++++++++++++++++--------------------- 1 file changed, 42 insertions(+), 31 deletions(-) diff --git a/docs/ci/jobs.md b/docs/ci/jobs.md index 93f4c4442..0dd6e0c66 100644 --- a/docs/ci/jobs.md +++ b/docs/ci/jobs.md @@ -57,92 +57,92 @@ Consists of **30 jobs** below: Build of Core into firmware. Regular version. **Are you looking for Trezor T firmware build? This is most likely it.** -### [core fw regular debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L41) +### [core fw regular debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L43) Build of Core into firmware with enabled _debug_ mode. In debug mode you can upload mnemonic seed, use debug link etc. which enables device tests. Storage on the device gets wiped on every start in this firmware. -### [core fw regular production build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L54) +### [core fw regular production build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L58) -### [core fw btconly build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L77) +### [core fw btconly build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L81) Build of Core into firmware. Bitcoin-only version. -### [core fw btconly debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L94) +### [core fw btconly debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L98) -### [core fw btconly production build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L117) +### [core fw btconly production build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L121) -### [core fw DISC1 build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L136) +### [core fw DISC1 build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L140) -### [core fw R debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L155) +### [core fw R debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L159) -### [core fw R build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L171) +### [core fw R build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L177) -### [core unix regular build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L188) +### [core unix regular build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L196) Non-frozen emulator build. This means you still need Python files present which get interpreted. -### [core unix regular asan build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L200) +### [core unix regular asan build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L208) -### [core unix frozen regular build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L219) +### [core unix frozen regular build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L227) Build of Core into UNIX emulator. Something you can run on your laptop. Frozen version. That means you do not need any other files to run it, it is just a single binary file that you can execute directly. -### [core unix frozen btconly debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L236) +### [core unix frozen btconly debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L244) Build of Core into UNIX emulator. Something you can run on your laptop. Frozen version. That means you do not need any other files to run it, it is just a single binary file that you can execute directly. See [Emulator](../core/emulator/index.md) for more info. Debug mode enabled, Bitcoin-only version. -### [core unix frozen btconly debug asan build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L252) +### [core unix frozen btconly debug asan build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L260) -### [core unix frozen debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L275) +### [core unix frozen debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L283) Build of Core into UNIX emulator. Something you can run on your laptop. Frozen version. That means you do not need any other files to run it, it is just a single binary file that you can execute directly. **Are you looking for a Trezor T emulator? This is most likely it.** -### [core unix frozen R debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L288) +### [core unix frozen R debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L296) -### [core unix frozen R debug build arm](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L302) +### [core unix frozen R debug build arm](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L310) -### [core unix frozen debug asan build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L320) +### [core unix frozen debug asan build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L328) -### [core unix frozen debug build arm](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L336) +### [core unix frozen debug build arm](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L344) -### [core macos frozen regular build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L358) +### [core macos frozen regular build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L366) -### [crypto build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L383) +### [crypto build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L391) Build of our cryptographic library, which is then incorporated into the other builds. -### [legacy fw regular build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L413) +### [legacy fw regular build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L421) -### [legacy fw regular debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L429) +### [legacy fw regular debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L437) -### [legacy fw btconly build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L446) +### [legacy fw btconly build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L454) -### [legacy fw btconly debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L465) +### [legacy fw btconly debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L473) -### [legacy emu regular debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L486) +### [legacy emu regular debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L494) Regular version (not only Bitcoin) of above. **Are you looking for a Trezor One emulator? This is most likely it.** -### [legacy emu regular debug asan build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L501) +### [legacy emu regular debug asan build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L509) -### [legacy emu regular debug build arm](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L519) +### [legacy emu regular debug build arm](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L527) -### [legacy emu btconly debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L545) +### [legacy emu btconly debug build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L553) Build of Legacy into UNIX emulator. Use keyboard arrows to emulate button presses. Bitcoin-only version. -### [legacy emu btconly debug asan build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L562) +### [legacy emu btconly debug asan build](https://github.com/trezor/trezor-firmware/blob/master/ci/build.yml#L570) --- ## TEST stage - [test.yml](https://github.com/trezor/trezor-firmware/blob/master/ci/test.yml) All the tests run test cases on the freshly built emulators from the previous `BUILD` stage. -Consists of **36 jobs** below: +Consists of **38 jobs** below: ### [core unit python test](https://github.com/trezor/trezor-firmware/blob/master/ci/test.yml#L15) Python unit tests, checking core functionality. @@ -232,7 +232,18 @@ Legacy device test - UI. ### [core unix memory profiler](https://github.com/trezor/trezor-firmware/blob/master/ci/test.yml#L719) -### [connect test core](https://github.com/trezor/trezor-firmware/blob/master/ci/test.yml#L743) +### [core firmware flash size checker](https://github.com/trezor/trezor-firmware/blob/master/ci/test.yml#L745) +Finds out how much flash space we have left in the firmware build +Fails if the free space is less than certain threshold + +### [core firmware flash size compare master](https://github.com/trezor/trezor-firmware/blob/master/ci/test.yml#L758) +Compares the current flash space with the situation in the current master +Fails if the new binary is significantly larger than the master one +(the threshold is defined in the script, currently 5kb). +Allowing fir failure, not to prevent the merge. +Also generates a report with the current situation + +### [connect test core](https://github.com/trezor/trezor-firmware/blob/master/ci/test.yml#L773) --- ## TEST-HW stage - [test-hw.yml](https://github.com/trezor/trezor-firmware/blob/master/ci/test-hw.yml)