diff --git a/.gitignore b/.gitignore index a40f1fd..9ea0f13 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ .* -!.gitignore \ No newline at end of file +!.gitignore diff --git a/tools/rules_config/README.md b/tools/rules_config/README.md index 2083a1f..e27db19 100644 --- a/tools/rules_config/README.md +++ b/tools/rules_config/README.md @@ -23,7 +23,7 @@ The new profile becomes the default profile for the language. - Got **'Admininister: Quality Profiles'** global permission on your account. - Check `_config.sh` file : - debug mode (`DEBUG` variable) : 0 to disable, 1 to enable - - simulation mode (`SIMULATION` variable) : 0 to disable, 1 to enable + - simulation mode (`SIMULATION` variable) : 0 to do real calls, 1 to simulate - Sonar token (`SONAR_TOKEN` variable) : put here the new added token previously - Sonar URL (`SONAR_URL` variable) : put here your custom Sonar URL ("http://localhost:9000" by default) - name of tag to add (`TAG_ECODESIGN` variable) : the name of the new tag to add to a list of rules @@ -32,7 +32,7 @@ The new profile becomes the default profile for the language. - language keys list (string format separated with one comma) (`PROFILES_LANGUAGE_KEYS` variable) : specify here the list of all keys language that you want to add the new ecocode quality profile - profiles set as default (`IS_PROFILE_ECODESIGN_DEFAULT` variable) : 1 if we want to set created profiles as default profile for each language, 0 if we don't want -## Local develop Environment +## Local develop Environment & prerequisites Differents environment have been used: @@ -87,7 +87,7 @@ Files : - `install_profile.sh` : create new custom profile -## How does it work ? +## How to - change configuration in `_config.sh` file : check requirements above - launch `check_tags.sh` to control your rules and tags diff --git a/tools/rules_config/_config.sh b/tools/rules_config/_config.sh index 32a421a..bf44d97 100755 --- a/tools/rules_config/_config.sh +++ b/tools/rules_config/_config.sh @@ -27,11 +27,13 @@ SONAR_URL=http://localhost:$SONAR_PORT # new tag to add to rules (tagging tools) or to use for rules added to new profiles created (install_profile tool) TAG_ECODESIGN=ecocode - ##### # additional configuration for "install_profile.sh" tool ##### +# list of rule keys that will be updated with new tag +RULES_KEYS=java:S1696 + # filepath to markdown doc containing rule keys that will be updated with new tag FILEPATH_SONAR_RULES_REUSED='./SONAR_RULES_REUSED.md' @@ -43,4 +45,4 @@ PROFILES_LANGUAGE_KEYS=php,py,java,cs # if we want to set created profiles as default profile for each language IS_PROFILE_ECODESIGN_DEFAULT=1 -#IS_PROFILE_ECODESIGN_DEFAULT=0 \ No newline at end of file +#IS_PROFILE_ECODESIGN_DEFAULT=0