Merge pull request #52 from lequal/dev

sonaricode 2.0

Author: begarco

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve this plugin
+title: ''
+labels: bug, to analyse
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots & log**
+If applicable, add screenshots to help explain your problem. Then, append SonarQube and i-Code log and **do not forget to obfuscate them**.
+
+**User environment (please complete the following information):**
+ - OS: [e.g. Windows 10]
+ - Java version: [e.g. 1.8]
+ - i-Code version: [e.g. 3.1.0]
+ - Plugin version: [e.g. 2.0.0]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for improving this plugin
+title: ''
+labels: enhancement, to analyse
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+> A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+> A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+> A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+> Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,25 @@
+---
+name: Question
+about: Ask a question about the usage of this plugin
+title: ''
+labels: question
+assignees: ''
+
+---
+
+> **Before posting a new question, please read the documentation](https://github.com/lequal/i-CodeCNES/wiki) and check [existing issues](https://github.com/lequal/sonar-icode-cnes-plugin/issues)**
+
+**Describe what you need to know**
+> A clear and concise description of what your question is.
+
+**Screenshots & log**
+> If applicable, add screenshots to help explain your problem. Then, append i-Code log and **do not forget to obfuscate them**.
+
+**User environment (please complete the following information):**
+ - OS: [e.g. Windows 10]
+ - Java version: [e.g. 1.8]
+ - i-Code version: [e.g. 3.1.0]
+ - Plugin version: [e.g. 2.0.0]
+
+**Additional context**
+Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,35 @@
+## Proposed changes
+
+> Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
+
+## Types of changes
+
+What types of changes does your code introduce to this plugin?
+> _Put an `x` in the boxes that apply_
+
+- [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation Update (if none of the other choices apply)
+
+## Issues closed by changes
+
+> _List here all issues closed by your changes. Use a list of items like `- [x] Close #0`_
+
+- [x] Close #0
+
+## Checklist
+
+> _Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
+
+- [ ] I have read the [CONTRIBUTING](https://github.com/lequal/sonar-icode-cnes-plugin/blob/master/CONTRIBUTING.md) doc
+- [ ] I agree with the [CODE OF CONDUCT](https://github.com/lequal/sonar-icode-cnes-plugin/blob/master/CONTRIBUTING.md)
+- [ ] Lint and unit tests pass locally with my changes
+- [ ] SonarCloud and Travis CI tests pass with my changes
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added necessary documentation (if appropriate)
+- [ ] Any dependent changes have been merged and published in downstream modules
+
+## Further comments
+
+> If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

.travis.yml

@@ -1,30 +1,35 @@
 language: java
-
 sudo: false
 install: true
 
+addons:
+  sonarcloud:
+    organization: "lequal"
+
 jdk:
-  - openjdk8
-  - openjdk11
+- openjdk8
+- openjdk11
+
+script:
+- mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar
 
 cache:
   directories:
-    - '$HOME/.m2/repository'
-    - '$HOME/.sonar/cache'
-    - '$HOME/.sonar/installs'
-
-addons:
-  sonarqube: true
+  - '$HOME/.m2/repository'
+  - '$HOME/.sonar/cache'
 
 notifications:
   email: false
 
-addons:
-  sonarcloud:
-    organization: "lequal"
-    token:
-      secure: projettest  # encrypted value of your token
-# Script to execute.
-
-script:
-  - mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent install sonar:sonar -Dsonar.host.url=https://sonarcloud.io -Dsonar.organization=lequal -Dsonar.login=181e22946e5e05302ceb4513dae3dcc9f7161f2f
+deploy:
+  provider: releases
+  api_key: "$GITHUB_TOKEN"
+  file_glob: true
+  file: "target/sonar-icode-cnes-plugin-*.jar"
+  skip_cleanup: true
+  name: "Sonar i-Code CNES plugin"
+  draft: true
+  on:
+    branch: master
+    tags: true
+    jdk: 'openjdk11'

CONTRIBUTING.md

@@ -1,36 +1,28 @@
-# Contributing to sonar-icode-cnes-plugin
-
+# Contributing to i-Code CNES plugin for SonarQube
 First off, thanks for taking the time to contribute!
-
-The following is a set of guidelines for contributing to sonar-icode-cnes-plugin, which are hosted in the [Lequal Organization](https://github.com/lequal) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+The following is a set of guidelines for contributing to i-Code CNES plugin for SonarQube, which are hosted in the [Lequal Organization](https://github.com/lequal) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
 
 #### Table Of Contents
-
-[Code of Conduct](#code-of-conduct)
-
-[How Can I Contribute?](#how-can-i-contribute)
-  * [Reporting Bugs](#reporting-bugs)
-  * [Suggesting Enhancements](#suggesting-enhancements)
++ [Code of Conduct](#code-of-conduct)
++ [How Can I Contribute?](#how-can-i-contribute)  
+  * [Reporting Bugs](#reporting-bugs)  
+  * [Suggesting Enhancements](#suggesting-enhancements)  
   * [Pull Requests](#pull-requests)
-
-[Git Commit Messages](#git-commit-messages)
+  * [Git Commit Messages](#git-commit-messages)
 
 ## Code of Conduct
-
 This project and everyone participating in it is governed by the [Lequal Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
 
 ## How Can I Contribute?
 
 ### Reporting Bugs
-
 Before creating bug reports, please check if the problem has already been reported. 
 
 #### How Do I Submit A (Good) Bug Report?
-
-Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Provide information by filling [the template](ISSUE_TEMPLATE.md).
+Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). 
+Provide information by filling [the template](.github/ISSUE_TEMPLATE/bug_report.md).
 
 Explain the problem and include additional details to help maintainers reproduce the problem:
-
 * **Use a clear and descriptive title** for the issue to identify the problem.
 * **Describe the exact steps which reproduce the problem** in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
 * **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, which you use in those examples.
@@ -39,43 +31,49 @@ Explain the problem and include additional details to help maintainers reproduce
 * **If you're reporting that the plugin crashed**, include a crash report with a stack trace from the operating system.
 
 Provide more context by answering these questions:
-
 * **Did the problem start happening recently** (e.g. after updating to a new version of the plugin or SonarQube) or was this always a problem?
 * If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most recent version in which the problem doesn't happen? You can download older versions from [the releases page](https://github.com/lequal/sonar-icode-cnes-plugin/releases).
 * **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
 
 Include details about your configuration and environment:
-
 * **Which SonarQube version are you using?** You can get the exact version at the bottom of your SonarQube instance.
 
 ### Suggesting Enhancements
-
 Before creating enhancement suggestions, please check if the problem has already been suggested.
 
 #### How Do I Submit A (Good) Enhancement Suggestion?
-
 Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). To submit en enhancement suggestion, create an issue and provide the following information:
-
 * **Use a clear and descriptive title** for the issue to identify the suggestion.
 * **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
 * **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
 * **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
 * **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of Atom which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
 * **Explain why this enhancement would be useful**
 * **Specify which version you're using.**
-* **Specify the SonarQube version you're using.** The SonarQube version is mentionned at the bottom of the web page.
+* **Specify the SonarQube version you're using.** The SonarQube version is mentioned at the bottom of the web page.
 
 ### Pull Requests
-
-* Fill in [the required template](PULL_REQUEST_TEMPLATE.md)
+* Fill in [the required template](.github/PULL_REQUEST_TEMPLATE.md)
 * Do not include issue numbers in the PR title
-* Include screenshots and animated GIFs in your pull request whenever possible.
-* Follow the Java styleguides.
-
-## Git Commit Messages
+* Include screenshots and animated GIFs in your pull request whenever possible
+* Follow the Java styleguides and fix all new SonarCloud issues
+* Test your code before opening the PR
+* Set the current `dev-*` branch as the target branch for your PR
 
+### Git Commit Messages
+* Start with the issue you are handling ("#187 ...")
 * Use the present tense ("Add feature" not "Added feature")
 * Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
 * Limit the first line to 72 characters or less
 * Reference issues and pull requests liberally after the first line
 * When only changing documentation, include `[ci skip]` in the commit description
+
+## Management of contributions
+
+All contributions are welcome. They are made via a *pull request* on the branch `dev` which is the branch of the next version.
+
+* pull request with **major** changes must be approved by at least one maintainer of each team and the LEQUAL.
+
+* pull requests with **minor** changes must be approved by at least one organization's member.
+ 
+All maintainers have the ability to merge *pull requests* on the `dev` branch. If several maintainers belong to the same team, their validation only counts for one organization.

ISSUE_TEMPLATE.md

@@ -7,19 +7,49 @@
 
 SonarQube plugin for the code analysis tool: i-Code CNES.
 
-SonarQube is an open platform to manage code quality. This plugin adds the ability to import i-Code results for Fortran (77 & 90) & Shell.
+SonarQube is an open platform to manage code quality. This plugin adds the ability to check Fortran (77 & 90) & Shell with i-Code or import pre-existing results of i-Code.
 
 This plugin is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
 
 You can get i-Code CNES on GitHub: [lequal/i-CodeCNES](https://github.com/lequal/i-CodeCNES).
 
 ### Quickstart
 - Setup a SonarQube instance.
-- Install i-Code command line application as described in [official documentation](https://github.com/lequal/i-CodeCNES/blob/master/documentation/i-Code%20CNES%20-%20Installation%20Manual%20-%20EN.pdf).
+- **[Optional]** Install i-Code command line application as described in [official documentation](https://github.com/lequal/i-CodeCNES/blob/master/documentation/i-Code%20CNES%20-%20Installation%20Manual%20-%20EN.pdf).
 - Install `sonaricode-*.jar` in `<SONARQUBE_HOME>/extensions/plugins/`.
-- Run i-Code manually or configure auto-launch in plugin configuration.
+- **[Optional]** Run i-Code manually or configure auto-launch in plugin configuration.
 - Run an analysis with *sonar-scanner*, *maven*, *gradle*, *msbuild*, etc.
 
+#### Run i-Code automatically
+This SonarQube plugin is now able to run automaticcaly an embedded version of i-Code. If you do not specify properties to run i-Code [manually](#run-i-Code-manually) or [from a specific version](#Run-a-specific-i-Code-version-through-sonaricode-plugin), embedded version of i-Code will be executed.
+
+Here is the compatibility matrix of the plugin:
+
+| sonaricode version | embedded i-Code version |
+|:------------------:|:-----------------------:|
+|       < 2.0.0      |           none          |
+|        2.0.0       |          4.0.0          |
+
+#### Run i-Code manually
+If you need help to run i-Code please refer to the [official user manual](https://github.com/lequal/i-CodeCNES/blob/master/documentation/i-Code%20CNES%20-%20User%20Manual.pdf) or [i-Code issue tracker](https://github.com/lequal/i-CodeCNES/issues).
+
+#### Run a specific i-Code version through sonaricode plugin
+If embedded version of i-Code does not match your need, you can set the execution of another installed version of i-Code through the following properties:
+- `sonar.icode.launch`: Activate autolaunch for i-Code if `true`. Default: `false`.
+- `sonar.icode.path`: Define i-Code CNES executable path to auto-launch it on analysis. Default: `${HOME}/icode-cnes/icode.exe`.
+
+#### Other plugin's properties
+- `sonar.icode.shell.file.suffixes`: List of suffixes for Shell files to analyze. Default: `.sh,.ksh,.bash`.
+- `sonar.icode.f77.file.suffixes`: List of suffixes for F77 files to analyze. Default: `.f,.f77,.for,.fpp,.ftn,.F,.F77,.FOR,.FPP,.FTN`.
+- `sonar.icode.f90.file.suffixes`: List of suffixes for F90 files to analyze. Default: `.f90,.F90`.
+- `sonar.icode.reports.path`: Path to the i-Code reports. Multiple path can be provided. Default: `result.res`.
+
+### Features
+- Fortran 77 analysis
+- Fortran 90 analysis
+- Shell analysis
+- Import i-Code results
+
 #### Get i-Code help
 Use `icode -h` to get the following help about i-Code:
 ````
@@ -41,25 +71,6 @@ Analyze Shell, F77 & F90 code to find defects & bugs.
 Please report issues at https://github.com/lequal/i-CodeCNES/issues
 ````
 
-#### Run i-Code manually
-If you need help to run i-Code please refer to the [official user manual](https://github.com/lequal/i-CodeCNES/blob/master/documentation/i-Code%20CNES%20-%20User%20Manual.pdf) or [i-Code issue tracker](https://github.com/lequal/i-CodeCNES/issues).
-
-#### Run i-Code through sonaricode plugin
-In order to run i-Code automatically when running *sonar-scanner*, following SoanrQube properties have to be given:
-- `sonar.icode.launch`: Activate autolaunch for i-Code if `true`. Default: `false`.
-- `sonar.icode.path`: Define i-Code CNES executable path to auto-launch it on analysis. Default: `${HOME}/icode-cnes/icode.exe`.
-
-#### Other plugin's properties
-- `sonar.icode.shell.file.suffixes`: List of suffixes for Shell files to analyze. Default: `.sh,.ksh,.bash`.
-- `sonar.icode.f77.file.suffixes`: List of suffixes for F77 files to analyze. Default: `.f,.f77,.for,.fpp,.ftn,.F,.F77,.FOR,.FPP,.FTN`.
-- `sonar.icode.f90.file.suffixes`: List of suffixes for F90 files to analyze. Default: `.f90,.F90`.
-- `sonar.icode.reports.path`: Path to the i-Code reports. Multiple path can be provided. Default: `result.res`.
-
-### Features
-- Fortran 77 analysis
-- Fortran 90 analysis
-- Shell analysis
-
 ### How to contribute
 If you experienced a problem with the plugin please open an issue. Inside this issue please explain us how to reproduce this issue and paste the log.