/docker-composer-require-checker

Dockerfile for maglnet/ComposerRequireChecker

Primary LanguageDockerfile

GitHub Action for composer-require-checker

This repo contains a Dockerfile to build https://github.com/maglnet/ComposerRequireChecker/ from scratch. Docker images are also available on the Hub at https://hub.docker.com/r/webfactory/composer-require-checker/tags.

GitHub Action

You can run it as a GitHub Action like so:

# .github/workflows/check.yml
on: [push, pull_request]
name: Main
jobs:
  composer-require-checker:
    name: ComposerRequireChecker
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: ComposerRequireChecker
      uses: docker://webfactory/composer-require-checker:2.1.0

This configuration will use the pre-built image at the Docker Hub. If you feel more secure with building the Docker Image ad-hoc from the Dockerfile in this repo, use the following syntax instead.

# .github/workflows/check.yml
on: [push, pull_request]
name: Main
jobs:
  composer-require-checker:
    name: ComposerRequireChecker
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: ComposerRequireChecker
-      uses: docker://webfactory/composer-require-checker:2.1.0
+      uses: webfactory/docker-composer-require-checker@0.1.0

Note: When using the Docker image, the tag refers to the Docker image tag. When referring to this repo, use a tag or commit hash for the Dockerfile.

Note: This will build the Docker image every time your workflow is run. The build will use the master branch of ComposerRequireChecker, not a stable release. If you know how the revision build-arg can be passed to Docker when running inside a GitHub action (so that you could specify the right version yourself), please open a PR.

In either case, to pass a custom config file, add this:

# .github/workflows/check.yml
on: [push]
name: Main
jobs:
  composer-require-checker:
    name: ComposerRequireChecker
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: ComposerRequireChecker
      uses: docker://webfactory/composer-require-checker:2.0.0
+      with:
+        args: --config-file=composer-require-checker.js

Docker

Apart from GitHub Actions, you can run the Docker image in any given directory:

docker run --rm -it -v ${PWD}:/app webfactory/composer-require-checker:2.0.0

Credits, Copyright and License

This action was written by webfactory GmbH, Bonn, Germany. We're a software development agency with a focus on PHP (mostly Symfony). If you're a developer looking for new challenges, we'd like to hear from you!

Copyright 2019 – 2020 webfactory GmbH, Bonn. Code released under the MIT license.