{"id":21617693,"url":"https://github.com/green-code-initiative/creedengo-php","last_synced_at":"2025-04-10T16:47:12.172Z","repository":{"id":186117634,"uuid":"674592681","full_name":"green-code-initiative/creedengo-php","owner":"green-code-initiative","description":"Reduce the environmental footprint of your PHP software programs","archived":false,"fork":false,"pushed_at":"2025-03-14T18:14:48.000Z","size":179,"stargazers_count":4,"open_issues_count":10,"forks_count":4,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-14T19:24:05.820Z","etag":null,"topics":["ecodesign","php","sonarqube","sonarqube-plugin"],"latest_commit_sha":null,"homepage":"https://green-code-initiative.org/","language":"Java","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/green-code-initiative.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-04T10:11:35.000Z","updated_at":"2025-03-14T18:13:58.000Z","dependencies_parsed_at":"2023-10-28T21:29:21.890Z","dependency_job_id":"89f60a28-ac59-4f34-93a8-b8ee8269186d","html_url":"https://github.com/green-code-initiative/creedengo-php","commit_stats":null,"previous_names":["green-code-initiative/ecocode-php","green-code-initiative/creedengo-php"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-code-initiative%2Fcreedengo-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-code-initiative%2Fcreedengo-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-code-initiative%2Fcreedengo-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-code-initiative%2Fcreedengo-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/green-code-initiative","download_url":"https://codeload.github.com/green-code-initiative/creedengo-php/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248254419,"owners_count":21073085,"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":["ecodesign","php","sonarqube","sonarqube-plugin"],"created_at":"2024-11-24T23:00:23.371Z","updated_at":"2025-04-10T16:47:12.163Z","avatar_url":"https://github.com/green-code-initiative.png","language":"Java","funding_links":[],"categories":["Java"],"sub_categories":[],"readme":"creedengo-php\n===========\n\n_creedengo_ is a collective project aiming to reduce environmental footprint of software at the code level. The goal of\nthe project is to provide a list of static code analyzers to highlight code structures that may have a negative\necological impact: energy and resources over-consumption, \"fatware\", shortening terminals' lifespan, etc.\n\n_creedengo_ is based on evolving catalogs\nof [good practices](https://github.com/green-code-initiative/creedengo-rules-specifications/blob/main/docs/rules), for various technologies.\nThis\nSonarQube plugin then implements these catalogs as rules for scanning your PHP projects.\n\n\u003e ⚠️ This is still a very early stage project. Any feedback or contribution will be highly appreciated. Please\n\u003e refer to the contribution section.\n\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/green-code-initiative/creedengo-common/blob/main/doc/CODE_OF_CONDUCT.md)\n\n🌿 SonarQube Plugins\n-------------------\n\nThis plugin is part of the creedengo project.\\\nYou can find a list of all our other plugins in\nthe [creedengo repository](https://github.com/green-code-initiative/creedengo#-sonarqube-plugins)\n\n🚀 Getting Started\n------------------\n\nYou can give a try with a one command docker :\n\n```sh\ndocker run -ti --rm \\\n       -p 9000:9000 \\\n       --name sonarqube-creedengo-php ghcr.io/green-code-initiative/sonarqube-creedengo-php:latest\n```\n\nor (with logs and data locally stored) :\n\n```sh\ndocker run -ti --rm \\\n       -v sq_creedengo_logs:/opt/sonarqube/logs \\\n       -v sq_creedengo_data:/opt/sonarqube/data \\\n       -p 9000:9000 \\\n       --name sonarqube-creedengo-php ghcr.io/green-code-initiative/sonarqube-creedengo-php:latest\n```\n\n... and configure local SonarQube (security config and quality profile : see [configuration](https://github.com/green-code-initiative/creedengo-common/blob/main/doc/HOWTO.md#configuration-sonarqube) for more details).\n\nTo install other `creedengo` plugins, you can also :\n\n- download each plugin separatly and copy the plugin (jar file) to `$SONAR_INSTALL_DIR/extensions/plugins` and restart SonarQube.\n- install different creedengo plugins with Marketplace (inside admin panel of SonarQube)\n\nThen you can use PHP test project repository to test the environment : see README.md of [PHP test project](https://github.com/green-code-initiative/creedengo-php-test-project)\n\n🛒 Distribution\n------------------\n\nReady to use binaries are available [from GitHub](https://github.com/green-code-initiative/creedengo-php/releases).\n\n🧩 Compatibility\n-----------------\n\n| Plugin version | SonarQube version | Java version |\n|----------------|-------------------|--------------|\n| 1.4.+          | 9.4.+ to 10.6.0   | 11 / 17      |\n| 1.5.+          | 9.9.+ to 10.6.0   | 17           |\n| 2.0.+          | 9.9.+ to 25.13.0  | 17           |\n\n\u003e Compatibility table of versions lower than 1.4.+ are available from the\n\u003e main [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications#-plugins-version-compatibility).\n\n🤝 Contribution\n---------------\n\ncheck [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications#-contribution)\n\n🤓 Main contributors\n--------------------\n\ncheck [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications#-main-contributors)\n\nLinks\n-----\n\n- https://docs.sonarqube.org/latest/analysis/overview/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-code-initiative%2Fcreedengo-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreen-code-initiative%2Fcreedengo-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-code-initiative%2Fcreedengo-php/lists"}