diff options
author | Takayuki Matsuoka <t-mat@users.noreply.github.com> | 2021-05-30 14:41:43 (GMT) |
---|---|---|
committer | Takayuki Matsuoka <t-mat@users.noreply.github.com> | 2021-05-30 14:41:43 (GMT) |
commit | 243f6b523319329d5ab585a42128b7337d6734d5 (patch) | |
tree | f3d5eb61760975619e8576674f444b4880ac0043 /.github/workflows/README.md | |
parent | e8a8fd6f0b8434c8e5c1ef5d87e9edcabb31f90d (diff) | |
download | lz4-243f6b523319329d5ab585a42128b7337d6734d5.zip lz4-243f6b523319329d5ab585a42128b7337d6734d5.tar.gz lz4-243f6b523319329d5ab585a42128b7337d6734d5.tar.bz2 |
Improve CI script
## Added compilers
- gcc: 4.[4678], 5, 6, 11
- clang: 3.[56789], 4, 5, 12
## Known issue
- make -C tests test-lz4c32
- Fails with all versions of clang. See #991 for details.
- CFLAGS='-O3 -mx32' make -C tests test-lz4c32
- Fails with all versions of clang
- Fails with gcc-11
- `make cxxtest`
- Disabled for now. Will be enabled after #993.
- `make c_standards_c90`, `make c_standards_c11`
- Disabled for now. Will be enabled after #994.
## Difference with `.travis.yml`
The following tests are not included yet.
- name: Compile OSS-Fuzz targets
- name: tag build
The following tests won't be included due to lmitation of the CI environment.
- name: aarch64 real-hw tests
- name: PPC64LE real-hw tests
- name: IBM s390x real-hw tests
Except above, all other features in `.travis.yml` has been included in this change set.
The following post describes details.
Diffstat (limited to '.github/workflows/README.md')
-rw-r--r-- | .github/workflows/README.md | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/.github/workflows/README.md b/.github/workflows/README.md new file mode 100644 index 0000000..0045d1e --- /dev/null +++ b/.github/workflows/README.md @@ -0,0 +1,78 @@ +This directory contains [GitHub Actions](https://github.com/features/actions) workflow files. + +# Known issue which will be resolved soon + +- `make cxxtest` + - Disabled for now. Will be enabled after #993. +- `make c_standards_c90`, `make c_standards_c11` + - Disabled for now. Will be enabled after #994. + + +# Maintenance Schedule + +`ubuntu-16.04` environment will be removed at September, 2021. +-------------------------------------------------------------- + +It also will remove test for the following compilers: + +- gcc: 4.4, 4.6, 4.7 +- clang: 3.5, 3.6, 3.7, 3.8 + +See also GitHub official announcement : +["Ubuntu 16.04 LTS will be removed on September 20, 2021"](https://github.blog/changelog/2021-04-29-github-actions-ubuntu-16-04-lts-virtual-environment-will-be-removed-on-september-20-2021/). + + +# Difference with `.travis.yml` + +The following tests are not included yet. + +- name: Compile OSS-Fuzz targets +- name: tag build +- name: aarch64 real-hw tests +- name: PPC64LE real-hw tests +- name: IBM s390x real-hw tests + + +# 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're 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 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=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` + + +## cppcheck.yml + +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 | +| gcc, tools | Environment info | |