Skip to content
🎵 + :octocat: Provides a GitHub action for running localheinz/composer-normalize.
Branch: master
Clone or download
localheinz Merge pull request #23 from localheinz/feature/composer-normalize
Enhancement: Update localheinz/composer-normalize
Latest commit a5b5902 Jun 1, 2019

README.md

composer-normalize-action

Build Status

What does this action do?

This action runs localheinz/composer-normalize with the --dry-run option.

That is, when you enable this action, the action will fail when a composer.json is pushed that is not valid or not already normalized.

Usage

Define a workflow in .github/main.workflow like this:

workflow "Main" {
  on = "push"
  resolves = ["composer-normalize"]
}

action "composer-normalize" {
  uses = "docker://localheinz/composer-normalize-action"
}

You can also use a specific tag, for example, x.y.z (otherwise, latest will be used).

workflow "Main" {
  on = "push"
  resolves = ["composer-normalize"]
}

action "composer-normalize" {
  uses = "docker://localheinz/composer-normalize-action:x.y.z"
}

💡 Also see GitHub Actions: Using a Dockerfile image in an action

Examples

To see this action in action, take a look at the following checks:

Docker

A docker image is automatically built and pushed to Docker Hub, see localheinz/composer-normalize-action.

You can execute the image by running

$ docker run --interactive --rm --tty --workdir=/app --volume ${PWD}:/app localheinz/composer-normalize-action

💡 Also see Docker Docs: Docker run reference.

Changelog

Please have a look at CHANGELOG.md.

Contributing

Please have a look at CONTRIBUTING.md.

Code of Conduct

Please have a look at CODE_OF_CONDUCT.md.

License

This package is licensed using the MIT License.

Credits

The implementation of this GitHub action is largely inspired by the work of Oskar Stark on the GitHub actions OskarStark/php-cs-fixer-ga and OskarStark/phpstan-ga.

You can’t perform that action at this time.