This CDK construct creates an [AWS Codebuild](https://www.sonarsource.com/products/sonarcloud/) action to perform static code analysis using [Sonarcloud](https://www.sonarsource.com/products/sonarcloud/).
# Getting started
Here is how to include the construct in your CDK code :
```javascript
const sonarcloudScan = new CDKCodeBuildSonarcloud(this, 'SonarcloudBuildAction', {
sourceOutput: sourceOutput,
sonarOrganizationName: 'my-sonarcloud-organization-name',
sonarProjectName: 'my-sonarcloud-project-name',
});
```
Check [Here](/examples/codepipeline-example.ts) for an example on how to use the construct.
# Security
A Sonarcloud account is required to use this construct. Create a Sonarcloud [token](https://docs.sonarsource.com/sonarcloud/advanced-setup/user-accounts/#user-tokens) to connect securely to Sonarcloud from AWS CodeBuild. Store this token in your AWS account in AWS Secret Manager, name the secret "sonar-token" and use "SONAR_TOKEN" as the secret key.
Please review the [AWS Secret Manager security best practices](https://docs.aws.amazon.com/prescriptive-guidance/latest/secure-sensitive-data-secrets-manager-terraform/best-practices.html) in order to securely create and manage your secret.
Raw data
{
"_id": null,
"home_page": "https://github.com/cdklabs/cdk-codebuild-sonarcloud.git",
"name": "cdk-codebuild-sonarcloud",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services<aws-cdk-dev@amazon.com>",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b2/bc/f85c38a16aed1dc969a369c6adadbefb66e5ecce044b08974f1946fdafd3/cdk_codebuild_sonarcloud-0.0.2.tar.gz",
"platform": null,
"description": "This CDK construct creates an [AWS Codebuild](https://www.sonarsource.com/products/sonarcloud/) action to perform static code analysis using [Sonarcloud](https://www.sonarsource.com/products/sonarcloud/).\n\n# Getting started\n\nHere is how to include the construct in your CDK code :\n\n```javascript\nconst sonarcloudScan = new CDKCodeBuildSonarcloud(this, 'SonarcloudBuildAction', {\n sourceOutput: sourceOutput,\n sonarOrganizationName: 'my-sonarcloud-organization-name',\n sonarProjectName: 'my-sonarcloud-project-name',\n});\n```\n\nCheck [Here](/examples/codepipeline-example.ts) for an example on how to use the construct.\n\n# Security\n\nA Sonarcloud account is required to use this construct. Create a Sonarcloud [token](https://docs.sonarsource.com/sonarcloud/advanced-setup/user-accounts/#user-tokens) to connect securely to Sonarcloud from AWS CodeBuild. Store this token in your AWS account in AWS Secret Manager, name the secret \"sonar-token\" and use \"SONAR_TOKEN\" as the secret key.\n\nPlease review the [AWS Secret Manager security best practices](https://docs.aws.amazon.com/prescriptive-guidance/latest/secure-sensitive-data-secrets-manager-terraform/best-practices.html) in order to securely create and manage your secret.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "cdk-codebuild-sonarcloud",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/cdklabs/cdk-codebuild-sonarcloud.git",
"Source": "https://github.com/cdklabs/cdk-codebuild-sonarcloud.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa008dae46b980635239ef936af616e1dc5b32431ec22ff34cbcc578c74fc9a3",
"md5": "85a0783193a4aa887252c0acaa42bebf",
"sha256": "174cb3fec5dc2b76bc6acda71f1156a87c63589b02a791a34714cb035e270838"
},
"downloads": -1,
"filename": "cdk_codebuild_sonarcloud-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85a0783193a4aa887252c0acaa42bebf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 30387,
"upload_time": "2024-09-20T07:17:57",
"upload_time_iso_8601": "2024-09-20T07:17:57.281532Z",
"url": "https://files.pythonhosted.org/packages/fa/00/8dae46b980635239ef936af616e1dc5b32431ec22ff34cbcc578c74fc9a3/cdk_codebuild_sonarcloud-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b2bcf85c38a16aed1dc969a369c6adadbefb66e5ecce044b08974f1946fdafd3",
"md5": "3b325c1becb982050dcc0d0c63473386",
"sha256": "5a3af84057ea0780a6cac68eabdce2368f0d645f5dfeb106945c5a40a1c5de70"
},
"downloads": -1,
"filename": "cdk_codebuild_sonarcloud-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "3b325c1becb982050dcc0d0c63473386",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 31332,
"upload_time": "2024-09-20T07:17:58",
"upload_time_iso_8601": "2024-09-20T07:17:58.879724Z",
"url": "https://files.pythonhosted.org/packages/b2/bc/f85c38a16aed1dc969a369c6adadbefb66e5ecce044b08974f1946fdafd3/cdk_codebuild_sonarcloud-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-20 07:17:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cdklabs",
"github_project": "cdk-codebuild-sonarcloud",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cdk-codebuild-sonarcloud"
}
JSON
