Docker Image: folderslint

Docker image that ships with the folderslint npm module.

Github Repository → https://github.com/sebastian-sommerfeld-io/docker-image-folderslint
Documentation → https://www.sommerfeld.io/docs/docker-images/docker-image-folderslint-docs/main
Published Docker images → https://hub.docker.com/r/sommerfeldio/folderslint
Docker image tag scheme → Guidelines and Conventions on docs.cloud.sommerfeld.io
Where to file issues → https://github.com/sebastian-sommerfeld-io/docker-image-folderslint/issues

About this image

The folderslint image is a utility Docker image used in Github Actions workflows to validate the directory structure of a project. The image ships with folderslint.

To see which packages are shipped with this image, take a look at the Dockerfile.

How to use this image

Use without a `Dockerfile`

To use the image without a Dockerfile run the following command. This create a /tmp/antora directory which contains all generated HTML, CSS, JS, etc.

docker run -it --rm --volume "$(pwd):$(pwd)" --workdir "$(pwd)" sommerfeldio/folderslint:latest folderslint

Use in a Github Actions workflow

lint-folders:
  runs-on: ubuntu-latest
  steps:
    - name: Checkout code
      uses: actions/checkout@v3
    - name: Run folderslint in container
      run: docker run -i --rm --volume "$(pwd):$(pwd)" --workdir "$(pwd)" sommerfeldio/folderslint:latest folderslint

Risks and Technical Debts

Scale for Probability and Impact: Low, Medium and High

#	Title	Description	Probability	Impact	Response
1	-	-	-	-	-

Title

Description

Probability

Impact

Response

Contact

Feel free to contact me via sebastian@sommerfeld.io or visit my website https://www.sommerfeld.io.