{"id":27235524,"url":"https://github.com/green-code-initiative/creedengo-csharp-sonarqube","last_synced_at":"2025-04-10T16:47:07.979Z","repository":{"id":251877126,"uuid":"800431142","full_name":"green-code-initiative/creedengo-csharp-sonarqube","owner":"green-code-initiative","description":"Reduce the environmental footprint of your C# software programs","archived":false,"fork":false,"pushed_at":"2025-02-24T15:03:59.000Z","size":84,"stargazers_count":3,"open_issues_count":2,"forks_count":4,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-02-24T15:39:57.870Z","etag":null,"topics":["csharp","eco-design","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":"2024-05-14T10:17:58.000Z","updated_at":"2024-11-19T18:54:18.000Z","dependencies_parsed_at":"2024-08-06T09:47:01.399Z","dependency_job_id":"685ffa98-e00d-4efc-86bb-4b1e57e2818f","html_url":"https://github.com/green-code-initiative/creedengo-csharp-sonarqube","commit_stats":null,"previous_names":["green-code-initiative/ecocode-csharp-sonarqube","green-code-initiative/creedengo-csharp-sonarqube"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-code-initiative%2Fcreedengo-csharp-sonarqube","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-code-initiative%2Fcreedengo-csharp-sonarqube/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-code-initiative%2Fcreedengo-csharp-sonarqube/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-code-initiative%2Fcreedengo-csharp-sonarqube/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-csharp-sonarqube/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248254397,"owners_count":21073077,"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":["csharp","eco-design","sonarqube","sonarqube-plugin"],"created_at":"2025-04-10T16:47:07.378Z","updated_at":"2025-04-10T16:47:07.955Z","avatar_url":"https://github.com/green-code-initiative.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"Creedengo C#\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/tree/main/docs/rules), for various technologies.\nThis SonarQube plugin then implements these catalogs as rules for scanning your C# projects.\n\nThis SonarQube plugin is based on a generated plugin from [SonarSource Sonarqube Roslyn SDK](https://github.com/SonarSource/sonarqube-roslyn-sdk) with a slightly different rules import process.\n\nThe _Creedengo C# Sonarqube plugin_ relies on the [Creedengo nuget package](https://www.nuget.org/packages/Creedengo) that is responsible of the codebase analysing part. You can then track detected issues within a compatible Sonarqube instance.\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-rules-specifications#-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-csharp ghcr.io/green-code-initiative/sonarqube-creedengo-csharp: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-csharp ghcr.io/green-code-initiative/sonarqube-creedengo-csharp: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#installing-local-environment-local-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 C# test project repository to test the environment : see README.md of [C# test project](https://github.com/green-code-initiative/creedengo-csharp-test-project)\n\nTo analyze a .net codebase without having to install required components (i.e. .net SDK, JDK/JRE, etc.), you can use our [docker dotnetscan wrapper](./docker-dotnetscan/README.md).\n\nFinally, you can directly use a [all-in-one docker-compose](https://github.com/green-code-initiative/creedengo-common/blob/main/doc/HOWTO.md#installing-local-environment-local-sonarqube)\n\nBy default, `Dockerfile` use the official [Sonarqube LTS Community](https://hub.docker.com/_/sonarqube) image version.\nYou can override this behaviour and use a custom version of your choice by specifying a `build-arg` to the build command, for example :\n\n```sh\ndocker build --build-arg SONARQUBE_VERSION=25.2.0.102705-community .\n```\n\nIf you want to use the `docker-compose` file, you can use the below commands to use an overrided `dockerfile` build :\n\n```sh\ndocker compose build --build-arg SONARQUBE_VERSION=25.2.0.102705-community\ndocker compose up -d --no-build\n```\n\n🛒 Distribution\n------------------\n\nReady to use binaries are available [from GitHub](https://github.com/green-code-initiative/creedengo-csharp-sonarqube/releases).\n\n🧩 Compatibility\n-----------------\n\n| Plugin version | SonarQube version   | creedengo nuget package version |\n| -------------- | ------------------- | ------------------------------- |\n| 1.1.0+         | 9.9.+ LTS to 10.5.1 | 1.1.0                           |\n| 2.1.0+         | 9.9.+ LTS and above | 2.1.0                           |\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- \u003chttps://docs.sonarqube.org/latest/analysis/overview/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-code-initiative%2Fcreedengo-csharp-sonarqube","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreen-code-initiative%2Fcreedengo-csharp-sonarqube","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-code-initiative%2Fcreedengo-csharp-sonarqube/lists"}