diff options
author | Takayuki Matsuoka <t-mat@users.noreply.github.com> | 2021-06-01 11:03:48 (GMT) |
---|---|---|
committer | Takayuki Matsuoka <t-mat@users.noreply.github.com> | 2021-06-01 11:03:48 (GMT) |
commit | 5b01b5805af3ccc2d293892d75626bbc945beb35 (patch) | |
tree | 60570ddc2acd1d570a1c7fed090349469909c964 /.github/workflows/README.md | |
parent | 02a41178b7457a3c3806170858715d87cd86e612 (diff) | |
download | lz4-5b01b5805af3ccc2d293892d75626bbc945beb35.zip lz4-5b01b5805af3ccc2d293892d75626bbc945beb35.tar.gz lz4-5b01b5805af3ccc2d293892d75626bbc945beb35.tar.bz2 |
Update document for .github/workflows
Diffstat (limited to '.github/workflows/README.md')
-rw-r--r-- | .github/workflows/README.md | 53 |
1 files changed, 24 insertions, 29 deletions
diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 0045d1e..eddfd3f 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -1,36 +1,15 @@ 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. --------------------------------------------------------------- +[`ubuntu-16.04` environment will be removed at September, 2021.]((https://github.blog/changelog/2021-04-29-github-actions-ubuntu-16-04-lts-virtual-environment-will-be-removed-on-september-20-2021/). +---------------------------------------------------------------- -It also will remove test for the following compilers: +We 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 @@ -42,7 +21,7 @@ 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. +See [#983](https://github.com/lz4/lz4/pull/983) for details. ## C Compilers (`lz4-c-compilers`) @@ -55,17 +34,19 @@ See https://github.com/lz4/lz4/pull/983 for details. - 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` + - `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.yml +## 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 @@ -75,4 +56,18 @@ Also sometimes it reports false positives. | ------------------------- | ------------------------------------- | | OS, VM | Set up job | | git repo, commit hash | Run actions/checkout@v2 | -| gcc, tools | Environment info | +| 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 |