{"id":13531765,"url":"https://github.com/ergebnis/composer-normalize-action","last_synced_at":"2025-04-01T20:30:32.156Z","repository":{"id":54161322,"uuid":"188209225","full_name":"ergebnis/composer-normalize-action","owner":"ergebnis","description":":octocat: + :musical_note: Provides a GitHub action for running ergebnis/composer-normalize.","archived":true,"fork":false,"pushed_at":"2021-03-06T14:12:21.000Z","size":195,"stargazers_count":26,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-04T10:17:15.855Z","etag":null,"topics":["composer","github-action","normalize"],"latest_commit_sha":null,"homepage":"https://github.com/ergebnis/composer-normalize","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ergebnis.png","metadata":{"funding":{"github":["ergebnis","localheinz"]},"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-23T10:05:20.000Z","updated_at":"2024-09-12T07:45:21.000Z","dependencies_parsed_at":"2023-01-04T12:30:37.131Z","dependency_job_id":null,"html_url":"https://github.com/ergebnis/composer-normalize-action","commit_stats":{"total_commits":83,"total_committers":1,"mean_commits":83.0,"dds":0.0,"last_synced_commit":"669a5cd049e5917c6574c4978db5db1f7789dfcb"},"previous_names":["localheinz/composer-normalize-action"],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ergebnis%2Fcomposer-normalize-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ergebnis%2Fcomposer-normalize-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ergebnis%2Fcomposer-normalize-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ergebnis%2Fcomposer-normalize-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ergebnis","download_url":"https://codeload.github.com/ergebnis/composer-normalize-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246709921,"owners_count":20821296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["composer","github-action","normalize"],"created_at":"2024-08-01T07:01:05.492Z","updated_at":"2025-04-01T20:30:31.845Z","avatar_url":"https://github.com/ergebnis.png","language":"Makefile","readme":"# composer-normalize-action\n\n[![Integrate](https://github.com/ergebnis/composer-normalize-action/workflows/Integrate/badge.svg)](https://github.com/ergebnis/composer-normalize-action/actions)\n[![Deploy](https://github.com/ergebnis/composer-normalize-action/workflows/Deploy/badge.svg)](https://github.com/ergebnis/composer-normalize-action/actions)\n\n## What does this action do?\n\nThis action runs [`ergebnis/composer-normalize`](https://github.com/ergebnis/composer-normalize).\n\n## Usage\n\nDefine a workflow in `.github/workflows/continuous-integration.yml` (or add a job if you already have defined workflows).\n\n:bulb: Read more about [Configuring a workflow](https://help.github.com/en/articles/configuring-a-workflow).\n\n### Default Behaviour\n\nBy default this action will run\n\n```\n$ composer normalize\n```\n\nin the working directory.\n\nWhen you use this action in a step with the default behaviour, the step will fail when\n\n- `composer.json` does not exist in this directory (be sure to checkout the code first, see [`actions/checkout`](https://github.com/actions/checkout))\n- `composer.json` is not valid\n- `composer.json` is valid, but `composer.lock` is not up-to-date with `composer.json`\n\nand the step will succeed when\n\n- `composer.json` is valid, `composer.lock` is not present, and `composer.json` and not yet normalized or could be successfully normalized\n- `composer.json` is valid, `composer.lock` is present and up-to-date, and `composer.json`, and `composer.json` and not yet normalized or could be successfully normalized\n\n:bulb: If you want the step to fail when `composer.json` is not yet normalized, you need to run with the `--dry-run` options, see below.\n\nHere's an example for a workflow configuration with the default behaviour:\n\n```yaml\nname: \"Integrate\"\n\non: \"push\"\n\njobs:\n  composer-normalize:\n    name: \"composer-normalize\"\n\n    runs-on: \"ubuntu-latest\"\n\n    steps:\n      - name: \"Checkout\"\n        uses: \"actions/checkout@v2\"\n\n      - name: \"Run composer normalize\"\n        uses: \"docker://ergebnis/composer-normalize-action:latest\"\n```\n\n### Custom Behavior\n\nIf you prefer to specify [arguments](https://github.com/ergebnis/composer-normalize/tree/main#arguments) or [options](https://github.com/ergebnis/composer-normalize/main#options) yourself, you can configure those using the `args` option:\n\n```diff\n name: \"Integrate\"\n\n on: \"push\"\n\n jobs:\n   composer-normalize:\n     name: \"composer-normalize\"\n\n     runs-on: \"ubuntu-latest\"\n\n     steps:\n       - name: \"Checkout\"\n         uses: \"actions/checkout@v2.0.0\"\n\n       - name: \"Run composer normalize\"\n         uses: \"docker://ergebnis/composer-normalize-action:latest\"\n+        with:\n+          args: \"--diff --dry-run --indent-size=2 --indent-style=space\"\n```\n\n### Docker image\n\nAs Docker images are automatically built and pushed on a merge to `main` or when a new tag is created in this repository, the recommended way to use this GitHub action is to reference the pre-built Docker image directly, as seen above.\n\n:bulb: The Docker image can also be executed directly by running\n\n```\n$ docker run --interactive --rm --tty --workdir=/app --volume ${PWD}:/app ergebnis/composer-normalize-action:latest\n```\n\nFor more information, see the [Docker Docs: Docker run reference](https://docs.docker.com/engine/reference/run/).\n\nInstead of using the latest pre-built Docker image, you can also specify a Docker image tag (which corresponds to the tags [released on GitHub](https://github.com/ergebnis/composer-normalize-action/releases)):\n\n```diff\n name: Integrate\n\n on: push\n\n jobs:\n   composer-normalize:\n     name: \"composer-normalize\"\n\n     runs-on: \"ubuntu-latest\"\n\n     steps:\n       - name: \"Checkout\"\n         uses: \"actions/checkout@v2\"\n\n       - name: \"Run composer normalize\"\n-        uses: \"docker://ergebnis/composer-normalize-action:latest\"\n+        uses: \"docker://ergebnis/composer-normalize-action:0.7.0\"\n```\n\n## Changelog\n\nPlease have a look at [`CHANGELOG.md`](CHANGELOG.md).\n\n## Contributing\n\nPlease have a look at [`CONTRIBUTING.md`](.github/CONTRIBUTING.md).\n\n## Code of Conduct\n\nPlease have a look at [`CODE_OF_CONDUCT.md`](https://github.com/ergebnis/.github/blob/main/CODE_OF_CONDUCT.md).\n\n## License\n\nThis package is licensed using the MIT License.\n\nPlease have a look at [`LICENSE.md`](LICENSE.md).\n\n## Credits\n\nThe implementation of this GitHub action is largely inspired by the work of [Oskar Stark](https://github.com/OskarStark) on the GitHub actions [`OskarStark/php-cs-fixer-ga`](https://github.com/OskarStark/php-cs-fixer-ga) and [`OskarStark/phpstan-ga`](https://github.com/OskarStark/phpstan-ga).\n","funding_links":["https://github.com/sponsors/ergebnis","https://github.com/sponsors/localheinz"],"categories":["Community Resources"],"sub_categories":["Static Analysis"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fergebnis%2Fcomposer-normalize-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fergebnis%2Fcomposer-normalize-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fergebnis%2Fcomposer-normalize-action/lists"}