Skip to content

Commit 2ae2d78

Browse files
committed
update GitHub Action badges for the generated package
1 parent 152b7e2 commit 2ae2d78

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

{{cookiecutter.project_name}}/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@
1414
| Static analysis | [![workflow scq badge](https://sonarcloud.io/api/project_badges/measure?project={{cookiecutter.github_organization}}_{{cookiecutter.project_name}}&metric=alert_status)](https://sonarcloud.io/dashboard?id={{cookiecutter.github_organization}}_{{cookiecutter.project_name}}) |
1515
| Coverage | [![workflow scc badge](https://sonarcloud.io/api/project_badges/measure?project={{cookiecutter.github_organization}}_{{cookiecutter.project_name}}&metric=coverage)](https://sonarcloud.io/dashboard?id={{cookiecutter.github_organization}}_{{cookiecutter.project_name}}) |
1616
| **GitHub Actions** |   |
17-
| Python Build | [![workflow python badge]({{cookiecutter.repository}}/workflows/Python/badge.svg)]({{cookiecutter.repository}}/actions?query=workflow%3A%22Python%22) |
18-
| PyPI Publish | [![workflow pypi badge]({{cookiecutter.repository}}/workflows/PyPI/badge.svg)]({{cookiecutter.repository}}/actions?query=workflow%3A%22PyPI%22) |
19-
| Metadata consistency | [![workflow tests badge]({{cookiecutter.repository}}/workflows/cffconvert/badge.svg)]({{cookiecutter.repository}}/actions?query=workflow%3A%22cffconvert%22) |
17+
| Build | [![build]({{cookiecutter.repository}}/actions/workflows/build.yml/badge.svg)]({{cookiecutter.repository}}/actions/workflows/build.yml) |
18+
| Metadata consistency | [![cffconvert]({{cookiecutter.repository}}/actions/workflows/cffconvert.yml/badge.svg)]({{cookiecutter.repository}}/actions/workflows/cffconvert.yml) |
19+
| Lint | [![lint]({{cookiecutter.repository}}/actions/workflows/lint.yml/badge.svg)]({{cookiecutter.repository}}/actions/workflows/lint.yml) |
20+
| Publish | [![publish]({{cookiecutter.repository}}/actions/workflows/publish.yml/badge.svg)]({{cookiecutter.repository}}/actions/workflows/publish.yml) |
21+
| SonarCloud | [![sonarcloud]({{cookiecutter.repository}}/actions/workflows/sonarcloud.yml/badge.svg)]({{cookiecutter.repository}}/actions/workflows/sonarcloud.yml) |
2022

2123
## How to use {{ cookiecutter.package_name }}
2224

{{cookiecutter.project_name}}/project_setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ git add --all
2020
git commit -m "first commit"
2121
git branch -M main
2222
git remote add origin {{ cookiecutter.repository }}
23-
# on github, create {{ cookiecutter.repository }} as an empty repository
23+
# on github, create {{ cookiecutter.repository }} as an empty repository
2424
git push --set-upstream origin main
2525
```
2626

@@ -97,7 +97,7 @@ help you decide which tool to use for packaging.
9797
3. add organization or reuse existing one
9898
4. set up repository
9999
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
100-
- The analysis will be run by [GitHub Action workflow](.github/workflows/quality.yml)
100+
- The analysis will be run by [GitHub Action workflow](.github/workflows/sonarcloud.yml)
101101
- 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)
102102

103103
## Package version number
@@ -113,7 +113,7 @@ help you decide which tool to use for packaging.
113113
To publish your package on PyPI, you need to create a [PyPI API token](https://pypi.org/help#apitoken) and
114114
save it as a secret called `PYPI_TOKEN` on [Settings page]({{cookiecutter.repository}}/settings/secrets/actions)
115115

116-
[Creating a release]({{cookiecutter.repository}}/releases/new) on GitHub will trigger a [GitHub action workflow](.github/workflows/pypi.yml) to publish the release on PyPI for you.
116+
[Creating a release]({{cookiecutter.repository}}/releases/new) on GitHub will trigger a [GitHub action workflow](.github/workflows/publish.yml) to publish the release on PyPI for you.
117117

118118
## Logging
119119

0 commit comments

Comments
 (0)