Hi Ævar
On 21/02/2022 14:46, Ævar Arnfjörð Bjarmason wrote:
> [...]
== Details
This series conflicts with and is a proposed alternative to Johannes's
proposed changes to teach "ci/lib.sh" GitHub specific syntax to
"group" certain parts of the output[2]. That series proposes to keep
the "ci/run-build-and-tests.sh" and similar scripts, but to teach them
to emit markers indicating when the "build" part commences, then
"test" etc.
I think the approach offered here is better as elaborated on in
12/25[1], especially because as Johannes notes[3] we only have one
level of "grouping" within a "step" available to us. In his version
using it for "build" v.s. "test" precludes being able to group parts
of that "build" or "test" output in the future.
The following compares CI output between the three with a
change-on-top which caused a compilation error ("this" is this series,
"js" is Johannes's) when clicking on the "linux-gcc" failure:
master: https://github.com/avar/git/runs/5274251909?check_suite_focus=true
this: https://github.com/avar/git/runs/5274464670?check_suite_focus=true
js: https://github.com/avar/git/runs/5272239403?check_suite_focus=true
Here we went from 93 lines of output on "master" to 47 in "this"
(107 in "js"). Note also how in "this" we can:
- Expand the "Run make" to get the "MAKEFLAGS" and other variables
used in the step. That's now a 3-line summary instead of the
first 50 lines being the old "ci/lib.sh" "set -x" output.
- Because "make" failed, we have an elided "make test" step that's
not being run below. We can thus see what steps our failure caused
us to skip.
- Unlike the "js" version we'll show the compilation error by
default (the "js" version is grouped and needs to be expanded),
but our output is now brief enough that that's no longer
surrounded by other irrelevant output.
- Unlike the "js" version there is no "CI setup" group within each
step. That work is in the earlier "ci/lib.sh --build" step
instead, which sets the config for all subsequent steps.
I can see that showing compilation errors without having to expand
anything is useful but in my experience they are relatively rare
compared to test failures. If I understand the rest of the message
correctly we're left with having to expand print-test-failures and
searching for "not ok" to find out what went wrong with this series.
For other output changes look at the difference between "master" and
"this" at:
master: https://github.com/git/git/actions/runs/1866786595
this: https://github.com/avar/git/actions/runs/1876270588
Not explicitly covered in the summary above is that various other
parts of ci/* were doing the same sort of within-step setup, but now
do so via cross-step passing of variables via $GITHUB_ENV. E.g. on
"master" the test slices for the Windows tests have a lot of verbosity
before they get to running the test itself:
https://github.com/git/git/runs/5254267914?check_suite_focus=true#step:5:56
In the "js" version the test output is hidden ("grouped"), but we've
got the same amount of verbosity by default:
https://github.com/gitgitgadget/git/runs/4937491771?check_suite_focus=true#step:5:67
Whereas in "this" version that verbosity is in the preceding "select
tests" step, with the "test" step showing only the relevant end-state
of the "$T" variable we'll use in the Makefile (hidden by default,
expanded in this link):
https://github.com/avar/git/runs/5274558869?check_suite_focus=true#step:7:13
All I can see in the "$T" variable I have to scroll to get the prove
output on screen
This series does not attempt to replace the use of the "group" output
used for the "ok" or "not ok" portion of tests in Johannes's
series. When a test fails the output in this series (sans config
discovery not being repeated, and now summarized in the $GITHUB_ENV
drop-down) is substantially the same as on "master".
My summary at [4] goes into other overlap & non-overlap between the
two. I think using the "group" output for those purposes might be
useful, although I left some feedback on [5] with problems in the
current "js" implementation.
I do think any such changes should follow behind this series, as doing
that sort of grouping once we can effectively free up an extra "group"
level (by peeling those off into "steps", as is done here) would be
much more useful.
I can see the attraction of being able to use make directly in the ci
from an implementation point of view but from the point of view of
someone trying to investigate a test failure then unless I've
misunderstood I don't think this series improves the current situation.
Why can't you build on top of Dscho's series that makes it easier to see
the output of the failed tests?
Best Wishes
Phillip
1. https://lore.kernel.org/git/patch-12.25-dfd823f2e7d-20220221T122605Z-avarab@xxxxxxxxx
2. https://lore.kernel.org/git/pull.1117.git.1643050574.gitgitgadget@xxxxxxxxx/
3. https://lore.kernel.org/git/9333ba781b8240f704e739b00d274f8c3d887e39.1643050574.git.gitgitgadget@xxxxxxxxx/
4. https://lore.kernel.org/git/220127.86ilu5cdnf.gmgdl@xxxxxxxxxxxxxxxxxxx/
5. https://lore.kernel.org/git/220126.86sftbfjl4.gmgdl@xxxxxxxxxxxxxxxxxxx/
Ævar Arnfjörð Bjarmason (25):
CI: run "set -ex" early in ci/lib.sh
CI: make "$jobname" explicit, remove fallback
CI: remove more dead Travis CI support
CI: remove dead "tree skipping" code
CI: remove unused Azure ci/* code
CI: don't have "git grep" invoke a pager in tree content check
CI: have "static-analysis" run a "make ci-static-analysis" target
CI: have "static-analysis" run "check-builtins", not "documentation"
CI: move p4 and git-lfs variables to ci/install-dependencies.sh
CI: consistently use "export" in ci/lib.sh
CI: export variables via a wrapper
CI: remove "run-build-and-tests.sh", run "make [test]" directly
CI: check ignored unignored build artifacts in "win[+VS] build" too
CI: invoke "make artifacts-tar" directly in windows-build
CI: split up and reduce "ci/test-documentation.sh"
CI: combine ci/install{,-docker}-dependencies.sh
CI: move "env" definitions into ci/lib.sh
ci/run-test-slice.sh: replace shelling out with "echo"
CI: pre-select test slice in Windows & VS tests
CI: only invoke ci/lib.sh as "steps" in main.yml
CI: narrow down variable definitions in --build and --test
CI: add more variables to MAKEFLAGS, except under vs-build
CI: stop over-setting the $CC variable
CI: set PYTHON_PATH setting for osx-{clang,gcc} into "$jobname" case
CI: don't use "set -x" in "ci/lib.sh" output
.github/workflows/main.yml | 100 +++++---
Makefile | 32 ++-
ci/check-directional-formatting.bash | 2 +-
ci/check-unignored-build-artifacts.sh | 20 ++
ci/install-dependencies.sh | 53 ++++-
ci/install-docker-dependencies.sh | 22 --
ci/lib-ci-type.sh | 10 +
ci/lib-tput.sh | 2 +
ci/lib.sh | 315 ++++++++++++--------------
ci/make-test-artifacts.sh | 12 -
ci/mount-fileshare.sh | 25 --
ci/print-test-failures.sh | 16 +-
ci/run-build-and-tests.sh | 54 -----
ci/run-docker-build.sh | 66 ------
ci/run-docker.sh | 47 ----
ci/run-static-analysis.sh | 32 ---
ci/run-test-slice.sh | 17 --
ci/select-test-slice.sh | 10 +
ci/test-documentation.sh | 37 +--
ci/util/extract-trash-dirs.sh | 50 ----
20 files changed, 345 insertions(+), 577 deletions(-)
create mode 100755 ci/check-unignored-build-artifacts.sh
delete mode 100755 ci/install-docker-dependencies.sh
create mode 100644 ci/lib-ci-type.sh
create mode 100644 ci/lib-tput.sh
delete mode 100755 ci/make-test-artifacts.sh
delete mode 100755 ci/mount-fileshare.sh
delete mode 100755 ci/run-build-and-tests.sh
delete mode 100755 ci/run-docker-build.sh
delete mode 100755 ci/run-docker.sh
delete mode 100755 ci/run-static-analysis.sh
delete mode 100755 ci/run-test-slice.sh
create mode 100755 ci/select-test-slice.sh
delete mode 100755 ci/util/extract-trash-dirs.sh
