[pull] dev from cnescatlab:dev

.github/workflows/close-milestone.yml

@@ -0,0 +1,39 @@
+# Description
+# ===========
+# This workflow is triggered each time the Java CI workflow succeeds
+# on master.
+# It looks for a milestone that is completed and close it.
+---
+name: Close Milestone
+
+on:
+  workflow_run:
+    workflows: ["Java CI"]
+    branches: [master]
+    types: 
+      - completed
+
+jobs:
+  close:
+    name: Close completed milestone
+    runs-on: ubuntu-22.04
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Close a milestone if completed
+        run: |
+          milestones=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+              https://api.github.com/repos/${{ github.repository }}/milestones \
+            | jq -r '. | map(select(.open_issues == 0 and .closed_issues > 0 and .state == "open"))')
+          if [ "$milestones" != "[]" ]
+          then
+            milestone_number=$(echo "$milestones" | jq -r '.[0].number')
+            curl -s \
+              -X PATCH \
+              -H "Authorization: token ${GITHUB_TOKEN}" \
+              -H "Accept: application/vnd.github.v3+json" \
+              https://api.github.com/repos/${{ github.repository }}/milestones/${milestone_number} \
+              -d '{"state":"closed"}'
+          fi
+        env:
+          # Personal access tokens should be generated from https://github.com/settings/tokens with repository scope
+          GITHUB_TOKEN: ${{ secrets.REPO_SCOPED_TOKEN }}

.github/workflows/draft-release.yml

@@ -0,0 +1,59 @@
+# Description
+# ===========
+# This workflow is triggered each time a milestone is closed
+# It builds the jar, generates release notes, pushes a new tag
+# and makes a draft release with these elements.
+---
+name: Draft Release
+
+on: 
+  milestone:
+    types: [closed]
+
+jobs:
+  release:
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    steps:
+    - name: Check out repository code
+      uses: actions/checkout@v4
+    - name: Setup java
+      uses: actions/setup-java@v4
+      with:
+        distribution: 'adopt'
+        java-version: '17'
+    - name: Cache Maven packages
+      uses: actions/cache@v4
+      with:
+        path: ~/.m2
+        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+        restore-keys: ${{ runner.os }}-m2
+    - name: Build with Maven
+      run: mvn -B clean package
+    - name: Create Release Notes
+      uses: docker://decathlon/release-notes-generator-action:2.0.1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        OUTPUT_FOLDER: temp_release_notes
+    - name: Set tag and project values
+      run: |
+        echo "tag=$(cat pom.xml | grep "<version>.*</version>" | head -1 |awk -F'[><]' '{print $3}')" >> $GITHUB_ENV
+        echo "project=$(echo ${{ github.repository }} | awk -F '/' '{print $2}')" >> $GITHUB_ENV
+    - name: Create a tag for the release
+      run: |
+        git config --global user.name "GitHub Actions"
+        git config --global user.email [email protected]
+        git tag -a ${{ env.tag }} -m "Release ${{ env.tag }}"
+        git push origin ${{ env.tag }}
+    - name: Create GitHub Release
+      uses: ncipollo/release-action@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        artifacts: "target/${{ env.project }}-${{ env.tag }}.jar"
+        tag: ${{ env.tag }}
+        name: ${{ env.project }} ${{ env.tag }}
+        bodyFile: "temp_release_notes/release_file.md"
+        draft: true
+        token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/java-continuous-integration.yml

@@ -0,0 +1,125 @@
+# Description
+# ===========
+# This workflow is triggered each time
+# commits are pushed to GitHub or a pull request is opened.
+# It launches three jobs in parallel : a build with java 8,
+# a build with java 11 and a SonarCloud analysis.
+---
+name: Java CI
+
+on: [push, pull_request]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        java: [ '17' ]
+    name: Java ${{ matrix.Java }} CI
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'adopt'
+          java-version: ${{ matrix.java }}
+      - name: Cache Maven packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - name: Cache node_modules
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: ${{ runner.os }}-yarn-
+      - name: Build with Maven
+        run: mvn -B clean package
+      - name: Test cnes-report
+        env:
+          SONARQUBE_VERSION: 10.5-community
+        run: |
+          version=$(cat pom.xml | grep "<version>.*</version>" | head -1 |awk -F'[><]' '{print $3}');
+          echo "Starting docker";
+          docker run --name sonarqube_${SONARQUBE_VERSION} -d -p 9000:9000 sonarqube:${SONARQUBE_VERSION};
+          echo "Inject plugin";
+          docker cp target/sonar-cnes-report-${version}.jar sonarqube_${SONARQUBE_VERSION}:/opt/sonarqube/extensions/plugins/;
+          docker restart sonarqube_${SONARQUBE_VERSION};
+          echo "Waiting up to 5 minutes for SonarQube...";
+          counter=0;
+          limit=300;
+          status_sonar=$(curl -s "http://localhost:9000/api/system/status" | grep "\"status\":\"UP\"" > /dev/null; echo $?);
+          while [[ 0 -ne $status_sonar && $counter -le $limit ]]; do
+              sleep 1;
+              counter=$(( $counter + 1 ));
+              status_sonar=$(curl -s "http://localhost:9000/api/system/status" | grep "\"status\":\"UP\"" > /dev/null; echo $?);
+          done;
+          echo "SonarQube is $([[ 0 -eq $status_sonar ]] && echo "up" || echo "down"), after $counter tries";
+          mvn sonar:sonar -Dsonar.host.url=http://localhost:9000 -Dsonar.login=admin -Dsonar.password=admin -Dsonar.organization=default-organization;
+          echo "Waiting for the SonarQube Compute Engine task to be completed...";
+          ce=$(grep ceTaskUrl= target/sonar/report-task.txt);
+          ceTaskUrl=${ce:10};
+          continue=true;
+          while [ $continue = true ]; do
+              status=$(curl -s -u admin:admin ${ceTaskUrl} | jq -r '.task.status');
+              if [ $status = SUCCESS ]
+              then
+                  continue=false;
+              elif [ $status = FAILED ] || [ $status = CANCELED ]
+              then
+                  exit 1;
+              else
+                  sleep 1;
+              fi
+          done;
+          token_sonarqube=$(curl -s -X POST -H "Content-Type&#58; application/x-www-form-urlencoded" -d "name=admin_token" -u admin:admin http://localhost:9000/api/user_tokens/generate | jq -r '.token');
+          java -jar target/sonar-cnes-report-${version}.jar -t ${token_sonarqube} -p fr.cnes.sonar:cnesreport -s http://localhost:9000;
+          url_cnesreport="http://localhost:9000/api/cnesreport/report?key=fr.cnes.sonar%3Acnesreport&author=github-actions&token=${token_sonarqube}";
+          curl -u admin:admin ${url_cnesreport} -O -J;
+
+  code-analysis:
+    runs-on: ubuntu-22.04
+    name: SonarCloud Code Analysis
+    # It's not possible to launch an analysis on external pull requests
+    if: ${{ github.repository_owner == 'cnescatlab' }}
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Setup java
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'adopt'
+          java-version: '17'
+      - name: Cache Maven packages
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - name: Cache node_modules
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: ${{ runner.os }}-yarn-
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v2
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Build and analyze
+        env:
+          # Needed to get some information about the pull request, if any
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # SonarCloud access token should be generated from https://sonarcloud.io/account/security/
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar -Dsonar.token=$SONAR_TOKEN

.gitignore

@@ -1,4 +1,11 @@
 target
 .idea
+.vscode
+.classpath
+.project
+.settings
 .scannerwork
-*.iml
+*.iml
+classes
+node_modules/
+node/

CONTRIBUTING.md

@@ -1,21 +1,17 @@
-# Contributing to sonar-cnes-report
-First off, thanks for taking the time to contribute! 
-The following is a set of guidelines for contributing to sonar-cnes-report, 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.
+# Contributing to CNES Report
+First off, thanks for taking the time to contribute!
+The following is a set of guidelines for contributing to CNES Report, which are hosted in the [CATLab organization](https://github.com/cnescatlab) 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)  
-* [Pull Requests](#pull-requests)
-
-[Git Commit Messages](#git-commit-messages)
++ [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)
 
 ## 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]).
+This project and everyone participating in it is governed by the [CATLab Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to us or [GitHub](https://github.com/contact/report-content).
 
 ## How Can I Contribute?
 
@@ -25,6 +21,7 @@ Before creating bug reports, please check if the problem has already been report
 #### 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).
+
 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.
@@ -35,7 +32,7 @@ Explain the problem and include additional details to help maintainers reproduce
 
 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-cnes-cxx-plugin/releases).
+* 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/cnescatlab/sonar-cnes-report/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:
@@ -56,14 +53,27 @@ Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com
 * **Specify the SonarQube version you're using.** The SonarQube version is mentionned 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.
+* 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
+### 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 CATLab.
+
+* 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.