This repository has taken much inspiration from PHPStan and OskarStark

The image is based on Alpine Linux and built daily.

• latest (latest/Dockerfile)
• stable (stable/Dockerfile)
• 4.x (4.x/Dockerfile)
• 3.x (3.x/Dockerfile)
• 2.x (2.x/Dockerfile)
• 1.x (1.x/Dockerfile)

Install the container:

docker pull nyholm/roave-bc-check

Alternatively, pull a specific version:

docker pull nyholm/roave-bc-check:4.x

We are recommend to use the images as an shell alias to access via short-command. To use simply roave-bc-check everywhere on CLI add this line to your ~/.zshrc, ~/.bashrc or ~/.profile.

alias roave-bc-check='docker run -v $PWD:/app --rm nyholm/roave-bc-check'

If you don't have set the alias, use this command to run the container:

docker run --rm -v /path/to/app:/app nyholm/roave-bc-check [some arguments for Roave Backward Compatibility Check]

For example:

docker run --rm -v `pwd`:/app nyholm/roave-bc-check  --format=markdown

You can use it as a Github Action like this:

.github/workflow/test.yml

on: [push, pull_request]
name: Test
jobs:
    roave_bc_check:
        name: Roave BC Check
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@master
            - name: Roave BC Check
              uses: docker://nyholm/roave-bc-check-ga

You can copy/paste the .github folder (under examples/) to your project and thats all!

The github action is always using the latest stable release of roave/backward-compatibility-check.

Docker images are built automatically every day. They are located here:

• nyholm/roave-bc-check
• nyholm/roave-bc-check-ga