https://github.com/green-code-initiative/creedengo-php
Reduce the environmental footprint of your PHP software programs
https://github.com/green-code-initiative/creedengo-php
ecodesign php sonarqube sonarqube-plugin
Last synced: about 1 month ago
JSON representation
Reduce the environmental footprint of your PHP software programs
- Host: GitHub
- URL: https://github.com/green-code-initiative/creedengo-php
- Owner: green-code-initiative
- License: gpl-3.0
- Created: 2023-08-04T10:11:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-14T18:14:48.000Z (2 months ago)
- Last Synced: 2025-03-14T19:24:05.820Z (2 months ago)
- Topics: ecodesign, php, sonarqube, sonarqube-plugin
- Language: Java
- Homepage: https://green-code-initiative.org/
- Size: 175 KB
- Stars: 4
- Watchers: 7
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
creedengo-php
===========
_creedengo_ is a collective project aiming to reduce environmental footprint of software at the code level. The goal of
the project is to provide a list of static code analyzers to highlight code structures that may have a negative
ecological impact: energy and resources over-consumption, "fatware", shortening terminals' lifespan, etc.
_creedengo_ is based on evolving catalogs
of [good practices](https://github.com/green-code-initiative/creedengo-rules-specifications/blob/main/docs/rules), for various technologies.
This
SonarQube plugin then implements these catalogs as rules for scanning your PHP projects.
> ⚠️ This is still a very early stage project. Any feedback or contribution will be highly appreciated. Please
> refer to the contribution section.
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/green-code-initiative/creedengo-common/blob/main/doc/CODE_OF_CONDUCT.md)
🌿 SonarQube Plugins
-------------------
This plugin is part of the creedengo project.\
You can find a list of all our other plugins in
the [creedengo repository](https://github.com/green-code-initiative/creedengo#-sonarqube-plugins)
🚀 Getting Started
------------------
You can give a try with a one command docker :
```sh
docker run -ti --rm \
-p 9000:9000 \
--name sonarqube-creedengo-php ghcr.io/green-code-initiative/sonarqube-creedengo-php:latest
```
or (with logs and data locally stored) :
```sh
docker run -ti --rm \
-v sq_creedengo_logs:/opt/sonarqube/logs \
-v sq_creedengo_data:/opt/sonarqube/data \
-p 9000:9000 \
--name sonarqube-creedengo-php ghcr.io/green-code-initiative/sonarqube-creedengo-php:latest
```
... 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).
To install other `creedengo` plugins, you can also :
- download each plugin separatly and copy the plugin (jar file) to `$SONAR_INSTALL_DIR/extensions/plugins` and restart SonarQube.
- install different creedengo plugins with Marketplace (inside admin panel of SonarQube)
Then 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)
🛒 Distribution
------------------
Ready to use binaries are available [from GitHub](https://github.com/green-code-initiative/creedengo-php/releases).
🧩 Compatibility
-----------------
| Plugin version | SonarQube version | Java version |
|----------------|-------------------|--------------|
| 1.4.+ | 9.4.+ to 10.6.0 | 11 / 17 |
| 1.5.+ | 9.9.+ to 10.6.0 | 17 |
| 2.0.+ | 9.9.+ to 25.13.0 | 17 |
> Compatibility table of versions lower than 1.4.+ are available from the
> main [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications#-plugins-version-compatibility).
🤝 Contribution
---------------
check [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications#-contribution)
🤓 Main contributors
--------------------
check [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications#-main-contributors)
Links
-----
- https://docs.sonarqube.org/latest/analysis/overview/