mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-05-03 10:50:10 -05:00
134 lines
5.4 KiB
Markdown
134 lines
5.4 KiB
Markdown
# GitHub Actions Status Badges
|
|
|
|
Add these badges to your README.md to show build status and coverage.
|
|
|
|
## CI/CD Status Badges
|
|
|
|
### Main CI Pipeline
|
|
```markdown
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/ci-comprehensive.yml)
|
|
```
|
|
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/ci-comprehensive.yml)
|
|
|
|
### Development Build
|
|
```markdown
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/cd-development.yml)
|
|
```
|
|
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/cd-development.yml)
|
|
|
|
### Release Build
|
|
```markdown
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/cd-release.yml)
|
|
```
|
|
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/cd-release.yml)
|
|
|
|
### Docker Publishing
|
|
```markdown
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/docker-publish.yml)
|
|
```
|
|
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/docker-publish.yml)
|
|
|
|
### Migration Check
|
|
```markdown
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/migration-check.yml)
|
|
```
|
|
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/migration-check.yml)
|
|
|
|
## Coverage Badges
|
|
|
|
### Codecov (if configured)
|
|
```markdown
|
|
[](https://codecov.io/gh/{owner}/{repo})
|
|
```
|
|
|
|
[](https://codecov.io/gh/{owner}/{repo})
|
|
|
|
## Docker Image Badges
|
|
|
|
### Docker Image Size
|
|
```markdown
|
|
[](https://github.com/{owner}/{repo}/pkgs/container/{repo})
|
|
```
|
|
|
|
[](https://github.com/{owner}/{repo}/pkgs/container/{repo})
|
|
|
|
### Docker Pulls
|
|
```markdown
|
|
[](https://github.com/{owner}/{repo}/pkgs/container/{repo})
|
|
```
|
|
|
|
## License and Version Badges
|
|
|
|
### License
|
|
```markdown
|
|
[](LICENSE)
|
|
```
|
|
|
|
[](LICENSE)
|
|
|
|
### Latest Release
|
|
```markdown
|
|
[](https://github.com/{owner}/{repo}/releases/latest)
|
|
```
|
|
|
|
[](https://github.com/{owner}/{repo}/releases/latest)
|
|
|
|
### Python Version
|
|
```markdown
|
|
[](https://www.python.org/downloads/)
|
|
```
|
|
|
|
[](https://www.python.org/downloads/)
|
|
|
|
## Complete Badge Example
|
|
|
|
Here's a complete set of badges you can add to your README:
|
|
|
|
```markdown
|
|
# TimeTracker
|
|
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/ci-comprehensive.yml)
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/cd-development.yml)
|
|
[](https://github.com/{owner}/{repo}/actions/workflows/cd-release.yml)
|
|
[](https://codecov.io/gh/{owner}/{repo})
|
|
[](LICENSE)
|
|
[](https://www.python.org/downloads/)
|
|
[](https://github.com/{owner}/{repo}/releases/latest)
|
|
```
|
|
|
|
## Instructions
|
|
|
|
1. Replace `{owner}` with your GitHub username or organization name
|
|
2. Replace `{repo}` with your repository name
|
|
3. Copy the badge markdown to your README.md
|
|
4. Commit and push to see the badges appear
|
|
|
|
## Custom Badges
|
|
|
|
You can create custom badges at [shields.io](https://shields.io/).
|
|
|
|
### Example: Test Coverage Custom Badge
|
|
```markdown
|
|

|
|
```
|
|
|
|
### Example: Build Status Custom Badge
|
|
```markdown
|
|

|
|
```
|
|
|
|
### Example: Tests Passing Badge
|
|
```markdown
|
|

|
|
```
|
|
|
|
---
|
|
|
|
**Note**: Replace `{owner}` and `{repo}` with your actual GitHub username and repository name.
|
|
|