Skip to content

Commit 3823119

Browse files
committed
Dont write next_steps.md + refactor project_setup
1 parent 1519a34 commit 3823119

2 files changed

Lines changed: 5 additions & 11 deletions

File tree

{{cookiecutter.project_name}}/.github/workflows/next_steps.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,11 @@ jobs:
5353
* Zenodo integration ${{ steps.zenodo.outputs.url }}
5454
* Readthedocs instructions ${{ steps.readthedocs.outputs.url }}
5555
* Citation data ${{ steps.citation.outputs.url }}
56-
* Linting fixes ${{ steps.linting.outputs.url }}' | tee -a next_steps.md
56+
* Linting fixes ${{ steps.linting.outputs.url }}'
5757
- name: Cleanup files needed to create next steps issues
5858
run: |
5959
git config --global user.name 'NLeSC Python template'
6060
git config --global user.email 'nlesc-python-template@users.noreply.github.com'
61-
git add next_steps.md
6261
git rm .github/workflows/next_steps.yml
6362
git rm -r .github/next_steps
6463
git commit -am "Cleanup automated next steps issue generator"

{{cookiecutter.project_name}}/project_setup.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -96,15 +96,10 @@ help you decide which tool to use for packaging.
9696

9797
## Continuous code quality
9898

99-
- [Sonarcloud](https://sonarcloud.io/) is used to perform quality analysis and code coverage report on each push
100-
- Sonarcloud must be configured for the analysis to work
101-
1. go to [Sonarcloud](https://sonarcloud.io/projects/create)
102-
2. login with your GitHub account
103-
3. add organization or reuse existing one
104-
4. set up repository
105-
5. go to [new code definition administration page](https://sonarcloud.io/project/new_code?id={{ cookiecutter.github_organization }}_{{ cookiecutter.project_name }}) and select `Number of days` option
106-
- The analysis will be run by [GitHub Action workflow](.github/workflows/sonarcloud.yml)
107-
- To be able to run the analysis, a token must be created at [Sonarcloud account](https://sonarcloud.io/account/security/) and this token must be added as `SONAR_TOKEN` to [secrets on GitHub](https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_name }}/settings/secrets/actions)
99+
[Sonarcloud](https://sonarcloud.io/) is used to perform quality analysis and code coverage report
100+
101+
- `sonar-project.properties` is the SonarCloud [configuration](https://docs.sonarqube.org/latest/analysis/analysis-parameters/) file
102+
- `.github/workflows/sonarcloud.yml` is the GitHub action workflow which performs the SonarCloud analysis
108103

109104
## Package version number
110105

0 commit comments

Comments
 (0)