diff options
author | Yann Collet <Cyan4973@users.noreply.github.com> | 2022-08-15 22:45:31 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-08-15 22:45:31 (GMT) |
commit | 5ff839680134437dbf4678f3d0c7b371d84f4964 (patch) | |
tree | 939d919c3903b42ed637542a4799fb3f4fa8b5fc /.github/workflows/README.md | |
parent | 416bc96faca629abcef42e56ecd2e20d26b79934 (diff) | |
parent | cfd6ab32522280079c2e6d3ea995f172b9ae0312 (diff) | |
download | lz4-5ff839680134437dbf4678f3d0c7b371d84f4964.zip lz4-5ff839680134437dbf4678f3d0c7b371d84f4964.tar.gz lz4-5ff839680134437dbf4678f3d0c7b371d84f4964.tar.bz2 |
stage v1.9.4
Diffstat (limited to '.github/workflows/README.md')
-rw-r--r-- | .github/workflows/README.md | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/.github/workflows/README.md b/.github/workflows/README.md new file mode 100644 index 0000000..306d875 --- /dev/null +++ b/.github/workflows/README.md @@ -0,0 +1,61 @@ +This directory contains [GitHub Actions](https://github.com/features/actions) workflow files. + +# Known issues + +## USAN, ASAN (`lz4-ubsan-x64`, `lz4-ubsan-x86`, `lz4-asan-x64`) + +For now, `lz4-ubsan-*` ignores the exit code of `make usan` and `make usan32`. +Because there are several issues which may take relatively long time to resolve. + +We'll fully enable it when we ensure `make usan` is ready for all commits and PRs. + +See [#983](https://github.com/lz4/lz4/pull/983) for details. + + +## C Compilers (`lz4-c-compilers`) + +- Our test doesn't use `gcc-4.5` due to installation issue of its package. (`apt-get install gcc-4.5` fails on GH-Actions VM) + +- Currently, the following 32bit executable tests fail with all versions of `clang`. + - `CC=clang-X CFLAGS='-O3' make V=1 -C tests clean test-lz4c32` + - `CC=clang-X CFLAGS='-O3 -mx32' make V=1 -C tests clean test-lz4c32` + - See [#991](https://github.com/lz4/lz4/issues/991) for details. + +- Currently, the following 32bit executable tests fail with `gcc-11` + - `CC=gcc-11 CFLAGS='-O3' make V=1 -C tests clean test-lz4c32` + - `CC=gcc-11 CFLAGS='-O3 -mx32' make V=1 -C tests clean test-lz4c32` + - See [#991](https://github.com/lz4/lz4/issues/991) for details. + + +## cppcheck (`lz4-cppcheck`) + +This test script ignores the exit code of `make cppcheck`. +Because this project doesn't 100% follow their recommendation. +Also sometimes it reports false positives. + + + +# Notes + +- You can investigate various information at the right pane of GitHub + Actions report page. + +| Item | Section in the right pane | +| ------------------------- | ------------------------------------- | +| OS, VM | Set up job | +| git repo, commit hash | Run actions/checkout@v2 | +| Version of tools | Environment info | + + + +# Difference with `.travis.yml` + +The following tests are not included yet. + +- name: Compile OSS-Fuzz targets + +The following tests will not be included due to limitation of GH-Actions. + +- name: aarch64 real-hw tests +- name: PPC64LE real-hw tests +- name: IBM s390x real-hw tests |