{"id":25519696,"url":"https://github.com/aligent/code-standards-pipe-php","last_synced_at":"2025-06-30T11:33:47.815Z","repository":{"id":37386394,"uuid":"426072568","full_name":"aligent/code-standards-pipe-php","owner":"aligent","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-27T23:21:56.000Z","size":99,"stargazers_count":0,"open_issues_count":3,"forks_count":1,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-02-16T13:23:57.780Z","etag":null,"topics":["pipe"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aligent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-11-09T03:03:34.000Z","updated_at":"2024-10-27T23:22:00.000Z","dependencies_parsed_at":"2023-11-24T06:30:32.397Z","dependency_job_id":"6f34255a-5e28-47be-a4f5-7b6479d42ea2","html_url":"https://github.com/aligent/code-standards-pipe-php","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fcode-standards-pipe-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fcode-standards-pipe-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fcode-standards-pipe-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fcode-standards-pipe-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aligent","download_url":"https://codeload.github.com/aligent/code-standards-pipe-php/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239703292,"owners_count":19683240,"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":["pipe"],"created_at":"2025-02-19T17:29:24.380Z","updated_at":"2025-02-19T17:29:24.942Z","avatar_url":"https://github.com/aligent.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Aligent Magento Code Standards Pipe\n\n\nThis pipe is used to perform PHP code standards checks.\n\n## YAML Definition\n\nAdd the following your `bitbucket-pipelines.yml` file:\n\n```yaml\n      - step:\n          name: \"Code Standards check\"\n          script:\n            - pipe: docker://aligent/code-standards-pipe-php:8.2\n              variables:\n                STANDARDS: \"Magento2\"\n                SKIP_DEPENDENCIES: \"true\"\n                MAGENTO_USER: \"USER\"\n                MAGENTO_PASS: \"PASS\"\n```\n\n### Github Actions\nThis pipe has partial support for Github actions. Please ensure that `SKIP_DEPENDENCIES` = `true`, and that the PHP version\nis correct for your project.\n\nCreate the following file as `.github/workflows/phpcs.yml`.\n\n```yaml\nname: Run PHP Code Style\n\non: pull_request\n  \njobs:\n  code-standards:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout code\n        uses: actions/checkout@v2\n        with:\n          fetch-depth: 0\n      - name: Code Standards Test\n        uses: docker://aligent/code-standards-pipe-php:8.1\n        env:\n          STANDARDS: \"Magento2\"\n          SKIP_DEPENDENCIES: \"true\"\n```\n\n## Variables\n\n| Variable              | Usage                                                       |\n| --------------------- | ----------------------------------------------------------- |\n| STANDARDS             | The PHPCS standards to run (Security checks will always be run) |\n| DEBUG                 | (Optional) Turn on extra debug information. Default: `false`. |\n| SKIP_DEPENDENCIES     | (Optional) Skip installing project composer dependencies. Default: `false`. For Github actions this should be set to `true`. |\n| MAGENTO_USER          | (Optional) Injects repo.magento.com user into auth.json |\n| MAGENTO_PASS          | (Optional) Injects repo.magento.com password into auth.json|\n| EXCLUDE_EXPRESSION    | (Optional) A grep [regular expression](https://www.gnu.org/software/grep/manual/html_node/Basic-vs-Extended.html) to exclude files from standards testing|\n\n## Local use\nAn intermediate build target `standards-runtime` is available which does not include the Bitbucket specific pip aspects. This essentially just provides a runtime for PHPCS which can be used by CLI tools and IDE integrations.\n\n\n## Development\n\nThe following command can be used to invoke the pipe locally:\n```\ndocker run -v $PWD:/build --workdir=/build aligent/code-standards-pipe-php:\u003cPHP_VERSION\u003e\n```\n\nCommits published to the `main` branch  will trigger an automated build for the each of the configured PHP version.\nCommits to `staging` will do the same but image tags will be suffixed with `-experimiental`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fcode-standards-pipe-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faligent%2Fcode-standards-pipe-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fcode-standards-pipe-php/lists"}