460-Add sonarcloud question - Githubissues

NLeSC / python-template

Netherlands eScience Center Python Template

https://research-software-directory.org/software/nlesc-python-template

Apache License 2.0

177 stars 76 forks source link

460-Add sonarcloud question #515

Closed fdiblen closed 3 weeks ago

fdiblen commented 3 weeks ago

Description

[X] I have read the contribution guidelines
[X] This update is in line with what is recommended in the Python chapter of the Guide
[X] All user facing changes have been added to CHANGELOG.md

This PR makes sonarcloud optional.

Related issues:

460

Instructions to review the pull request

Install the requirements

cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
pip install pipx
pipx install copier

Test 1:

Step-1: Run the command below and say 'yes' to sonarcloud question

copier copy --vcs-ref 460_sonarcloud https://github.com/nlesc/python-template test_yes

Step-2: Run the command below and say 'no' to sonarcloud question

copier copy --vcs-ref 460_sonarcloud https://github.com/nlesc/python-template test_no

What to check: You should see the files below only when you say 'yes':

.github/workflows/next_steps_sonarcloud.yml
.github/workflows/next_steps_sonarcloud_issue.md
.github/workflows/sonarcloud.yml
sonar-project.properties

Check if there are mentions of sonar, sonarcloud or analysis in any file of the generated package.

Test 2:

Push the generated package to a GitHub repository
Check if sonarcloud.yml workflow runs (probably it will fail)
Check if next_steps_sonarcloud.yml workflow runs
Check if next_steps_sonarcloud.yml workflow is removed after run
Check if a GitHub issue about sonar cloud is created

lyashevska commented 3 weeks ago

Clean up did not work for me, see here: https://github.com/lyashevska/test-sonarcloud/actions/runs/10505693029/job/29104011849