cpp-linter/clang-tools-docker

🐳 Clang Tools Docker image includes the clang-format and clang-tidy.

Clang Tools Docker image

🐳 The Clang Tools Docker image includes the clang-format and clang-tidy.

You can find all the clang-tools Docker images on Docker Hub registry or GitHub Packages registry.

Supported tags and respective Dockerfile links

• all (Supported versions of clang-tools includes 18, 17, 16, 15, 14, 13, 12, 11, 10, 9)
• 18
• 17
• 16
• 16-alpine
• 15
• 14
• 13
• 12
• 11
• 10
• 9
• 8
• 7

How to use clang-tools Docker images

Docker run image

# Check clang-format version
$ docker run xianpengshen/clang-tools:17 clang-format --version
Ubuntu clang-format version 17.0.0 (+rc4-1~exp5ubuntu1)
# Format code (helloworld.c in the demo directory)
$ docker run -v $PWD:/src xianpengshen/clang-tools:17 clang-format --dry-run -i helloworld.c

# Check clang-tidy version
$ docker run xianpengshen/clang-tools:17 clang-tidy --version
Ubuntu LLVM version 17.0.0
  Optimized build.

# Diagnostic code (helloworld.c in the demo directory)
$ docker run -v $PWD:/src xianpengshen/clang-tools:17 clang-tidy helloworld.c \
-checks=boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-cplusplus-*,clang-analyzer-*,cppcoreguidelines-*

As base image in Dockerfile

FROM xianpengshen/clang-tools:17

WORKDIR /src

COPY . .

CMD [ "" ]

Then build and run the Docker image:

$ docker build -t clang-tools .

# Check clang-format version
$ docker run clang-tools clang-format --version
Ubuntu clang-format version 17.0.0 (+rc4-1~exp5ubuntu1)
# Format code
$ docker run clang-tools clang-format --dry-run -i helloworld.c

# Check clang-tidy version
$ docker run clang-tools clang-tidy --version
Ubuntu LLVM version 17.0.0
  Optimized build.
# Diagnostic code
$ docker run clang-tools clang-tidy helloworld.c \
-checks=boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-cplusplus-*,clang-analyzer-*,cppcoreguidelines-*

Have question or feedback?

To provide feedback (requesting a feature or reporting a bug) please post to issues.

License

Apache License

clang-tools-docker's Issues

Update GitHub Packages registry from shenxianpeng to cpp-linter

Since I have transferred this docker image repo to cpp-linter, I should also update the registry account to cpp-linter.

I also want to do a download docker images performance test comparison.

• Download form Docker hub
• Download from GitHub package registry

To see if could reduce the download image time of cpp-linter-action project.

Update Dockerfiles to fix issues reported by hadolint

For example:

sh-4.2$ make lint FILE=11/Dockerfile 
echo 11/Dockerfile
11/Dockerfile
== Linting 11/Dockerfile...
Output Lint results
-:5 DL3015 info: Avoid additional packages by specifying `--no-install-recommends`
-:5 SC2086 info: Double quote to prevent globbing and word splitting.
make: *** [lint] Error 1

Support clang-tools v17

https://packages.ubuntu.com/search?suite=default&section=all&arch=any&keywords=clang-format-17&searchon=names

Labelling container images

https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#labelling-container-images

Auto publish docker image to docker hub and ghcr.io with action

Cancel

Support different versions of clang-format and clang-tidy

`docker buildx bake --file docker-bake.hcl linux`

https://docs.docker.com/engine/reference/commandline/buildx_bake/

LLVM's clang license agreement

I was just reading through part 4 of the Apache License distributed with clang software. I think you need to include a copy of that License (you may keep your MIT License in addition) with this repo because you're (in a way) distributing clang software.

Maybe docker images are an exception to this (a copy of the License should already be in the built docker image), but it would probably be safer to do it anyway (there are stipulations about redistributing in either "source" or "object" forms).

Pre release Clang versions? like 14 and 15

Is it possible to add even those?

Need to update README.md

Create a build/test/publish image workflow

Create a build/test/publish the workflow to prevent any clang-tool image is not working and automatic build and publish the image to docker hub.

Support clang-tools `v15`

It seems llvm 15.0.0 will be released, will create clang-tools v15 later https://github.com/llvm/llvm-project/releases/tag/llvmorg-15.0.0

support clang-tools v18

Support clang v16

https://github.com/llvm/llvm-project/releases/tag/llvmorg-16.0.0

System.IO.IOException: No space left on device

https://github.com/cpp-linter/clang-tools-docker/actions/runs/8246898893

[build](https://github.com/cpp-linter/clang-tools-docker/actions/runs/8246898893/job/22553930490)
System.IO.IOException: No space left on device : '/home/runner/runners/2.314.1/_diag/Worker_20240312-100158-utc.log'
   at System.IO.RandomAccess.WriteAtOffset(SafeFileHandle handle, ReadOnlySpan`1 buffer, Int64 fileOffset)
   at System.IO.Strategies.BufferedFileStreamStrategy.FlushWrite()
   at System.IO.StreamWriter.Flush(Boolean flushStream, Boolean flushEncoder)
   at System.Diagnostics.TextWriterTraceListener.Flush()
   at GitHub.Runner.Common.HostTraceListener.WriteHeader(String source, TraceEventType eventType, Int32 id)
   at GitHub.Runner.Common.HostTraceListener.TraceEvent(TraceEventCache eventCache, String source, TraceEventType eventType, Int32 id, String message)
   at System.Diagnostics.TraceSource.TraceEvent(TraceEventType eventType, Int32 id, String message)
   at GitHub.Runner.Worker.Worker.RunAsync(String pipeIn, String pipeOut)
   at GitHub.Runner.Worker.Program.MainAsync(IHostContext context, String[] args)
System.IO.IOException: No space left on device : '/home/runner/runners/2.314.1/_diag/Worker_20240312-100158-utc.log'
   at System.IO.RandomAccess.WriteAtOffset(SafeFileHandle handle, ReadOnlySpan`1 buffer, Int64 fileOffset)
   at System.IO.Strategies.BufferedFileStreamStrategy.FlushWrite()
   at System.IO.StreamWriter.Flush(Boolean flushStream, Boolean flushEncoder)
   at System.Diagnostics.TextWriterTraceListener.Flush()
   at GitHub.Runner.Common.HostTraceListener.WriteHeader(String source, TraceEventType eventType, Int32 id)
   at GitHub.Runner.Common.HostTraceListener.TraceEvent(TraceEventCache eventCache, String source, TraceEventType eventType, Int32 id, String message)
   at System.Diagnostics.TraceSource.TraceEvent(TraceEventType eventType, Int32 id, String message)
   at GitHub.Runner.Common.Tracing.Error(Exception exception)
   at GitHub.Runner.Worker.Program.MainAsync(IHostContext context, String[] args)
Unhandled exception. System.IO.IOException: No space left on device : '/home/runner/runners/2.314.1/_diag/Worker_20240312-100158-utc.log'
   at System.IO.RandomAccess.WriteAtOffset(SafeFileHandle handle, ReadOnlySpan`1 buffer, Int64 fileOffset)
   at System.IO.Strategies.BufferedFileStreamStrategy.FlushWrite()
   at System.IO.StreamWriter.Flush(Boolean flushStream, Boolean flushEncoder)
   at System.Diagnostics.TextWriterTraceListener.Flush()
   at System.Diagnostics.TraceSource.Flush()
   at GitHub.Runner.Common.TraceManager.Dispose(Boolean disposing)
   at GitHub.Runner.Common.TraceManager.Dispose()
   at GitHub.Runner.Common.HostContext.Dispose(Boolean disposing)
   at GitHub.Runner.Common.HostContext.Dispose()
   at GitHub.Runner.Worker.Program.Main(String[] args)

'stddef.h' file not found in v13 and v14

[/usr/include/stdio.h:33:10 [clang-diagnostic-error]: usr/include/stdio.h#L33]
'stddef.h' file not found

For more discussion of this issue, see https://github.com/shenxianpeng/cpp-linter-action/issues/51

Support test docker images with bats

https://bats-core.readthedocs.io/en/stable/index.html

Update supported versions in clang-tools:all docker images

At this point clang-tools:all docker images support version includes 12 11 10 9 8 7 6.0.

Since there are 13, 14 releases, we should include 13, 14 while removing 7, 6.0 old releases to keep clang-tools:all from being too big(currently it is 1.2 GB).

This should not affect https://github.com/shenxianpeng/cpp-linter-action as few people use it yet, most people use the default version 10.

Change ENV variable to `CLANG_VERSIONS` in Dockerfiles

Based on @2bndy5's proposal in the issue cpp-linter/cpp-linter-action#73

@shenxianpeng It might be easier to identify when using the docker at runtime if the docker image set a environment variable. We could probably do this from the action.yml in this repo, but it might be good to have in the docker container.

If we could more easily identify when the docker is in use (at runtime), then we can make this path prepending conditional on the presence of the docker workspace.

To meet the above needs and have a specific ENV variable name, we don't need to add a new one, just change the current ENV from VERSIONS to CLANG_VERSIONS should be OK.
https://github.com/cpp-linter/clang-tools/blob/c864e94186fd1fce17fd12775636b9cf507c5243/all/Dockerfile#L5
https://github.com/cpp-linter/clang-tools/blob/c864e94186fd1fce17fd12775636b9cf507c5243/all/Dockerfile#L15

Optimize dockerfiles and create makefile

Drop support for 6.0 version of clang-tools