Improve "Build Binaries" and "Build Test" GitHub Actions #1463

thisiskeithb · 2020-12-30T18:24:38Z

Description

Copy config.ini when building binaries so the version located in Copy to SD Card root directory to update/ won't have to be updated each time the main version in TFT/src/User/ is updated.
Ignore changes to the following files/folders for automatic binary/config uploads:
- .devcontainer/
- .github/
- Bootloader/
- Copy to SD Card root directory to update/
- images/
- readme/
- *.md
Ignore changes to the following files/folders for build tests:
- Bootloader/
- Copy to SD Card root directory to update/
- images/
- readme/
- *.md

Tagging @Codel1417 as they introduced automatic binary uploads in #1450

Benefits

Automate updating config.ini in the "Copy to SD Card" folder and only run CI when needed & don't upload new binaries when readmes/non-code changes are committed.

Related Issues

None.

Codel1417 · 2020-12-30T19:31:44Z

I like this, i need to open another pr to copy the config.ini so we are not maintaining 2 versions of it

thisiskeithb · 2020-12-30T19:37:05Z

I like this, i need to open another pr to copy the config.ini so we are not maintaining 2 versions of it

What about changing the build action to zip up & tag releases instead? That'll keep the repo size down by removing all the compiled firmware as well.

Codel1417 · 2020-12-30T20:21:04Z

i worry about posting releases too fast for little features + handling release names. I would like to see more releases though

oldman4U · 2020-12-30T21:18:42Z

bit off topic and maybe just my 2 cents, but at the moment we have 2 config.ini files and maybe it would be possible to remove the one under the TFT/src/User folder and keep only the one in the Copy to SD Card root directory to update folder

thisiskeithb · 2020-12-30T21:35:01Z

bit off topic and maybe just my 2 cents, but at the moment we have 2 config.ini files and maybe it would be possible to remove the one under the TFT/src/User folder and keep only the one in the Copy to SD Card root directory to update folder

I’d keep the one in the TFT/src/User/ folder so it doesn’t become “out of sight, out of mind” and like @Codel1417 mentioned, just script an action to duplicate it to the Copy to SD Card root directory to update folder on each automatic build.

thisiskeithb · 2020-12-30T21:59:44Z

Speaking of the Copy to SD Card root directory to update folder, that could probably be excluded from the CI/build test too.

~~I’ll update the PR when I’m back at a computer and can push another commit.~~ Done!

thisiskeithb · 2020-12-31T00:42:36Z

The last commit limits binary building to only run in this (bigtreetech/BIGTREETECH-TouchScreenFirmware) repo, since you end up with double commits/binary replacement when syncing or rebasing your fork.

thisiskeithb · 2020-12-31T19:44:56Z

@Codel1417: The last commit copies config.ini from TFT/src/User/ to Copy to SD Card root directory to update/ when running the build action.

oldman4U · 2020-12-31T22:35:07Z

Sorry to be such a pain, but can I ask why the two config.ini's are needed?

I am not a complete newbie but it happened to me twice that I edited the one and copied the other to the SD card. It is just confusing to have the same file twice.

Codel1417 · 2020-12-31T22:39:46Z

Sorry to be such a pain, but can I ask why the two config.ini's are needed?

I am not a complete newbie but it happened to me twice that I edited the one and copied the other to the SD card. It is just confusing to have the same file twice.

Its easier for users that want something to just work without looking for files.

oldman4U · 2021-01-01T07:07:52Z

Not sure I understand. Easier it would be to have one, like it is the case for all other files. Codel1417 <notifications@github.com> schrieb am Do. 31. Dez. 2020 um 23:39:

…

Sorry to be such a pain, but can I ask why the two config.ini's are needed? I am not a complete newbie but it happened to me twice that I edited the one and copied the other to the SD card. It is just confusing to have the same file twice. Its easier for users that want something to just work without looking for files. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1463 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AM6XKZF32CJ4M5U6MWYYM4TSXT4T3ANCNFSM4VOSY2JQ> .

thisiskeithb · 2021-01-01T08:17:51Z

Easier it would be to have one

I agree.

Ideally, the Copy to SD Card root directory to update folder wouldn’t exist and BigTreeTech would use GitHub’s Releases feature to attach precompiled firmware, config, images, etc. for SD updating as well as the source code, but that’s not the process here.

The duplicate config.ini issue exists because one sits along side Configuration.h in the source code folder for developers and the other sits in the Copy to SD Card root directory to update folder alongside the firmware binaries so it’s in one place for users.

Since this PR now duplicates config.ini, it’s a non-issue.

oldman4U · 2021-01-01T09:19:35Z

A developer is used to work with files in different folders. The common user is having issues to find the compiled firmware once he came to the point being able to compile at all. I am afraid that you implemented a solution for a problem which finally does not fix the root of it. As always - just my 2 cents as a dump user. Keith Bennett <notifications@github.com> schrieb am Fr. 1. Jän. 2021 um 09:18:

…

Easier it would be to have one I agree. Ideally, the Copy to SD Card root directory to update folder wouldn’t exist and BigTreeTech would use GitHub’s Releases feature to attach precompiled firmware, config, images, etc. for SD updating as well as the source code, but that’s not the process here. The duplicate config.ini issue exists because one sits along side Configuration.h in the source code folder for developers and the other sits in the Copy to SD Card root directory to update folder alongside the firmware binaries so it’s in one place for users. Since this PR now duplicates config.ini, it’s a non-issue. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1463 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AM6XKZCKRYG4IAJ7AQLRG4TSXWALVANCNFSM4VOSY2JQ> .

guruathwal · 2021-01-03T16:04:44Z

@oldman4U as explained by @thisiskeithb, while navigating through the file list tree in VS Code and when there are many files opened in the editor it is easier to find config.ini when it is in the src directory. The config.ini file in Copy to SD Card root directory to update is in a different hierarchy. A copy is placed in Copy to SD Card root directory to update so that all the files needed by the user to flash/update the device are at one place.

@thisiskeithb please add '**/*.ini' also to paths-ignore: in buildBinary.yml

oldman4U · 2021-01-03T18:03:35Z

I am concerned about the situation once the average user finished the download and starts working on it.

This reverts commit ff5f697.

thisiskeithb · 2021-01-05T23:45:51Z

please add '**/*.ini' also to paths-ignore: in buildBinary.yml

I pushed this change initially, but there's a potential for the latest config.ini file to not get pushed out to the Copy to SD Card root directory to update folder since the "Build Binaries" actions wouldn't run if that's the only file edited in a PR.

…#1463)

thisiskeithb added 2 commits December 30, 2020 10:14

Ignore bootloader & readme dirs for automatic binary updating

6362019

Ignore bootloader & readme dirs for build test

3415448

thisiskeithb changed the title ~~Ignore markdown, bootloader, and readme directories for automatic binary updating & CI tests~~ Ignore non-code files/folders for automatic binary updating & CI test tweaks Dec 30, 2020

Exclude some more folders

74829be

thisiskeithb marked this pull request as draft December 30, 2020 21:59

Exclude "copy to SD card" folder

0065160

thisiskeithb marked this pull request as ready for review December 31, 2020 00:21

Only run "Build Binaries" on main TFT firmware repo

ed0fd6c

Update Build Binaries git info

ec81277

thisiskeithb changed the title ~~Ignore non-code files/folders for automatic binary updating & CI test tweaks~~ Improve "Build Binaries" and "Build Test" GitHub Actions Dec 31, 2020

Copy Config.ini too

953fc6a

oldman4U mentioned this pull request Jan 1, 2021

[FR] IDEA: remote firmware deploy with build.py #361

Closed

Don't rebuild after changes to INI files

ff5f697

Revert "Don't rebuild after changes to INI files"

cb98310

This reverts commit ff5f697.

bigtreetech merged commit e48249c into bigtreetech:master Jan 7, 2021

thisiskeithb deleted the pr/ignore_markdown_ci branch January 7, 2021 09:47

sarvenn mentioned this pull request Jan 24, 2021

[FR] Pre-build Firmwares to be Updated when Marlin & BTT SKR Configs are Updated bigtreetech/BIGTREETECH-SKR-mini-E3#494

Closed

jeffeb3 pushed a commit to V1EngineeringInc/BIGTREETECH-TouchScreenFirmware that referenced this pull request Nov 10, 2021

Improve "Build Binaries" and "Build Test" GitHub Actions (bigtreetech…

1e73312

…#1463)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve "Build Binaries" and "Build Test" GitHub Actions #1463

Improve "Build Binaries" and "Build Test" GitHub Actions #1463

thisiskeithb commented Dec 30, 2020 •

edited

Loading

Codel1417 commented Dec 30, 2020

thisiskeithb commented Dec 30, 2020 •

edited

Loading

Codel1417 commented Dec 30, 2020

oldman4U commented Dec 30, 2020

thisiskeithb commented Dec 30, 2020

thisiskeithb commented Dec 30, 2020 •

edited

Loading

thisiskeithb commented Dec 31, 2020 •

edited

Loading

thisiskeithb commented Dec 31, 2020

oldman4U commented Dec 31, 2020

Codel1417 commented Dec 31, 2020

oldman4U commented Jan 1, 2021 via email

thisiskeithb commented Jan 1, 2021

oldman4U commented Jan 1, 2021 via email

guruathwal commented Jan 3, 2021

oldman4U commented Jan 3, 2021

thisiskeithb commented Jan 5, 2021

Improve "Build Binaries" and "Build Test" GitHub Actions #1463

Improve "Build Binaries" and "Build Test" GitHub Actions #1463

Conversation

thisiskeithb commented Dec 30, 2020 • edited Loading

Description

Benefits

Related Issues

Codel1417 commented Dec 30, 2020

thisiskeithb commented Dec 30, 2020 • edited Loading

Codel1417 commented Dec 30, 2020

oldman4U commented Dec 30, 2020

thisiskeithb commented Dec 30, 2020

thisiskeithb commented Dec 30, 2020 • edited Loading

thisiskeithb commented Dec 31, 2020 • edited Loading

thisiskeithb commented Dec 31, 2020

oldman4U commented Dec 31, 2020

Codel1417 commented Dec 31, 2020

oldman4U commented Jan 1, 2021 via email

thisiskeithb commented Jan 1, 2021

oldman4U commented Jan 1, 2021 via email

guruathwal commented Jan 3, 2021

oldman4U commented Jan 3, 2021

thisiskeithb commented Jan 5, 2021

thisiskeithb commented Dec 30, 2020 •

edited

Loading

thisiskeithb commented Dec 30, 2020 •

edited

Loading

thisiskeithb commented Dec 30, 2020 •

edited

Loading

thisiskeithb commented Dec 31, 2020 •

edited

Loading