Merge branch 'main' into 464-codeconduct

lyashevska · lyashevska · commit 63f7fbf5770e · 2024-08-22T16:03:36.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Added
 
 * Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530)
+* Make SonarCloud optional [#515](https://github.com/NLeSC/python-template/pull/515)
 * Make citation optional [#471](https://github.com/NLeSC/python-template/pull/471)
 * Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)
 * Added Python 3.12 support [#356](https://github.com/NLeSC/python-template/issues/356)
diff --git a/copier.yml b/copier.yml
@@ -23,6 +23,7 @@ version:
 github_organization:
   type: str
   default: "<my-github-organization>"
+  help: Enter the name of your GitHub username or organization
 full_name:
   type: str
   default: Jane Smith
@@ -114,6 +115,12 @@ AddCodeConduct:
   help: Add code of conduct?
 
 
+AddSonarCloud:
+  when: "{{ template_profile == 'ask' }}"
+  type: bool
+  default: "{{ template_profile != 'minimum' }}"
+  help: Add SonarCloud (code analysis service) integration?
+
 # internal fields
 _subdirectory: template
 
diff --git a/profiles.md b/profiles.md
@@ -22,7 +22,7 @@
   - project_setup.md
 
 - code quality:
-  - sonarcloud
+  - sonarcloud #515
   - ruff and lint workflow
   - github action to build (exist) #451
   - pre-commit
diff --git a/template/.github/workflows/next_steps.yml b/template/.github/workflows/next_steps.yml
@@ -8,13 +8,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Create Sonarcloud integration issue
-        uses: JasonEtco/create-an-issue@v2
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          filename: .github/next_steps/01_sonarcloud_integration.md
-        id: sonarcloud
       - name: Create Zenodo integration issue
         uses: JasonEtco/create-an-issue@v2
         env:
@@ -32,7 +25,6 @@ jobs:
       - name: List created issues
         run: |
           echo 'Created issues that must be completed to have fully working Python package:
-          * Sonarcloud integration ${{ steps.sonarcloud.outputs.url }}
           * Zenodo integration ${{ steps.zenodo.outputs.url }}
           * Linting fixes ${{ steps.linting.outputs.url }}'
       - name: Cleanup files needed to create next steps issues
diff --git a/template/.github/workflows/{% if AddCitation %}next_steps_citation.yml{% endif %} b/template/.github/workflows/{% if AddCitation %}next_steps_citation.yml{% endif %}
@@ -13,7 +13,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          filename: .github/next_steps/02_citation.md
+          filename: .github/workflows/next_steps_citation_issue.md
         id: citation
       - name: List created issues
         run: |
@@ -23,7 +23,8 @@ jobs:
         run: |
           git config --global user.name 'NLeSC Python template'
           git config --global user.email 'nlesc-python-template@users.noreply.github.com'
+          git pull # other next step workflows may push changes before
           git rm .github/workflows/next_steps_citation.yml
-          git rm -r .github/next_steps
-          git commit -am "Cleanup automated next steps issue generator"
+          git rm .github/workflows/next_steps_citation_issue.md
+          git commit -am "Cleanup automated next steps issue generator for citation"
           git push
diff --git a/template/.github/workflows/{% if AddCitation %}next_steps_citation_issue.md{% endif %}.jinja b/template/.github/workflows/{% if AddCitation %}next_steps_citation_issue.md{% endif %}.jinja
diff --git a/template/.github/workflows/{% if AddOnlineDocumentation %}next_steps_online_documentation.yml{% endif %} b/template/.github/workflows/{% if AddOnlineDocumentation %}next_steps_online_documentation.yml{% endif %}
@@ -8,12 +8,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Create readthedocs issue
+      - name: Create online documentation issue
         uses: JasonEtco/create-an-issue@v2
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          filename: .github/next_steps/03_readthedocs.md
+          filename: .github/workflows/next_steps_online_documentation_issue.md
         id: readthedocs
       - name: List created issues
         run: |
@@ -23,7 +23,8 @@ jobs:
         run: |
           git config --global user.name 'NLeSC Python template'
           git config --global user.email 'nlesc-python-template@users.noreply.github.com'
+          git pull # other next step workflows may push changes before
           git rm .github/workflows/next_steps_online_documentation.yml
-          git rm -r .github/next_steps
-          git commit -am "Cleanup automated next steps issue generator"
+          git rm .github/workflows/next_steps_online_documentation_issue.md
+          git commit -am "Cleanup automated next steps issue generator for online documentation"
           git push
diff --git a/template/.github/workflows/{% if AddOnlineDocumentation %}next_steps_online_documentation_issue.md{% endif %}.jinja b/template/.github/workflows/{% if AddOnlineDocumentation %}next_steps_online_documentation_issue.md{% endif %}.jinja
diff --git a/template/.github/workflows/{% if AddSonarCloud %}next_steps_sonarcloud.yml{% endif %} b/template/.github/workflows/{% if AddSonarCloud %}next_steps_sonarcloud.yml{% endif %}
@@ -0,0 +1,30 @@
+on: [push]
+permissions:
+  contents: write
+  issues: write
+name: Create an issue for Sonarcloud
+jobs:
+  next_steps:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Create Sonarcloud issue
+        uses: JasonEtco/create-an-issue@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          filename: .github/workflows/next_steps_sonarcloud_issue.md
+        id: sonarcloud
+      - name: List created issues
+        run: |
+          echo 'Created issues that must be completed to have fully working Python package:
+          * Sonarcloud integration ${{ steps.sonarcloud.outputs.url }}'
+      - name: Cleanup files needed to create next steps issues
+        run: |
+          git config --global user.name 'NLeSC Python template'
+          git config --global user.email 'nlesc-python-template@users.noreply.github.com'
+          git pull # other next step workflows may push changes before
+          git rm .github/workflows/next_steps_sonarcloud.yml
+          git rm .github/workflows/next_steps_sonarcloud_issue.md
+          git commit -am "Cleanup automated next steps issue generator for sonarcloud"
+          git push
diff --git a/template/.github/workflows/{% if AddSonarCloud %}next_steps_sonarcloud_issue.md{% endif %}.jinja b/template/.github/workflows/{% if AddSonarCloud %}next_steps_sonarcloud_issue.md{% endif %}.jinja
diff --git a/template/.github/workflows/{% if AddSonarCloud %}sonarcloud.yml{% endif %} b/template/.github/workflows/{% if AddSonarCloud %}sonarcloud.yml{% endif %}
@@ -36,5 +36,5 @@ jobs:
       - name: SonarCloud Scan
         uses: SonarSource/sonarcloud-github-action@master
         env:
-          GITHUB_TOKEN: ${{ '{{' -}} secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
-          SONAR_TOKEN: ${{ '{{' -}} secrets.SONAR_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
diff --git a/template/README.md.jinja b/template/README.md.jinja
@@ -11,8 +11,10 @@
 | (5/5) checklist                    | [![workflow cii badge](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>/badge)](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>) |
 | howfairis                          | [![fair-software badge](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow)](https://fair-software.eu) |
 | **Other best practices**           | &nbsp; |
+{% if AddSonarCloud -%}
 | Static analysis                    | [![workflow scq badge](https://sonarcloud.io/api/project_badges/measure?project={{github_organization}}_{{package_name}}&metric=alert_status)](https://sonarcloud.io/dashboard?id={{github_organization}}_{{package_name}}) |
 | Coverage                           | [![workflow scc badge](https://sonarcloud.io/api/project_badges/measure?project={{github_organization}}_{{package_name}}&metric=coverage)](https://sonarcloud.io/dashboard?id={{github_organization}}_{{package_name}}) |
+{%- endif -%}
 {% if AddOnlineDocumentation -%}
 | Documentation                      | [![Documentation Status](https://readthedocs.org/projects/{{package_name}}/badge/?version=latest)](https://{{package_name}}.readthedocs.io/en/latest/?badge=latest) |
 {%- endif -%}
@@ -21,7 +23,9 @@
 {% if AddCitation -%}
 | Citation data consistency          | [![cffconvert]({{repository_url}}/actions/workflows/cffconvert.yml/badge.svg)]({{repository_url}}/actions/workflows/cffconvert.yml) |
 {%- endif -%}
+{% if AddSonarCloud -%}
 | SonarCloud                         | [![sonarcloud]({{repository_url}}/actions/workflows/sonarcloud.yml/badge.svg)]({{repository_url}}/actions/workflows/sonarcloud.yml) |
+{%- endif -%}
 | MarkDown link checker              | [![markdown-link-check]({{repository_url}}/actions/workflows/markdown-link-check.yml/badge.svg)]({{repository_url}}/actions/workflows/markdown-link-check.yml) |
 
 ## How to use {{ package_name }}
diff --git a/template/project_setup.md.jinja b/template/project_setup.md.jinja
@@ -66,12 +66,14 @@ help you decide which tool to use for packaging.
 
 - [Relevant section in the NLeSC guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=coding-style-conventions) and [README.dev.md](README.dev.md).
 
+{% if AddSonarCloud -%}
 ## Continuous code quality
 
 [Sonarcloud](https://sonarcloud.io/) is used to perform quality analysis and code coverage report
 
 - `sonar-project.properties` is the SonarCloud [configuration](https://docs.sonarqube.org/latest/analysis/analysis-parameters/) file
 - `.github/workflows/sonarcloud.yml` is the GitHub action workflow which performs the SonarCloud analysis
+{%- endif -%}
 
 ## Package version number
 
diff --git a/template/{% if AddSonarCloud %}sonar-project.properties{% endif %}.jinja b/template/{% if AddSonarCloud %}sonar-project.properties{% endif %}.jinja
