{"id":29427499,"url":"https://github.com/tagdots/setup-badge-action","last_synced_at":"2026-04-17T06:34:26.784Z","repository":{"id":303689496,"uuid":"1016351023","full_name":"tagdots/setup-badge-action","owner":"tagdots","description":"Run setup-badge to create shields.io endpoint badges to showcase on your README","archived":false,"fork":false,"pushed_at":"2026-03-15T05:16:12.000Z","size":151,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-15T17:26:37.551Z","etag":null,"topics":["action","automation","badge","devops","github-actions","python","readme","setup-badge","shields","utilities"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tagdots.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-08T22:03:33.000Z","updated_at":"2026-01-04T07:38:14.000Z","dependencies_parsed_at":"2025-07-08T23:21:01.781Z","dependency_job_id":"0bd4bc55-77a7-4466-988f-c3da10c4a391","html_url":"https://github.com/tagdots/setup-badge-action","commit_stats":null,"previous_names":["tagdots/setup-badge-action"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/tagdots/setup-badge-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tagdots%2Fsetup-badge-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tagdots%2Fsetup-badge-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tagdots%2Fsetup-badge-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tagdots%2Fsetup-badge-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tagdots","download_url":"https://codeload.github.com/tagdots/setup-badge-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tagdots%2Fsetup-badge-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31918712,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T18:22:33.417Z","status":"online","status_checked_at":"2026-04-17T02:00:06.879Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["action","automation","badge","devops","github-actions","python","readme","setup-badge","shields","utilities"],"created_at":"2025-07-12T13:08:59.819Z","updated_at":"2026-04-17T06:34:26.765Z","avatar_url":"https://github.com/tagdots.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# setup-badge-action\n\n[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10951/badge)](https://www.bestpractices.dev/projects/10951)\n[![CI](https://github.com/tagdots/setup-badge/actions/workflows/ci.yaml/badge.svg)](https://github.com/tagdots/setup-badge/actions/workflows/ci.yaml)\n[![marketplace](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/tagdots/setup-badge/refs/heads/badges/badges/marketplace.json)](https://github.com/marketplace/actions/setup-badge-action)\n[![coverage](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/tagdots/setup-badge/refs/heads/badges/badges/coverage.json)](https://github.com/tagdots/setup-badge/actions/workflows/cron-tasks.yaml)\n\n\nThis action runs [setup-badge](https://github.com/tagdots/setup-badge) to generate badges to showcase on your README.\n\n\u003cbr\u003e\n\n## ⭐ How setup-badge-action works\n\n**setup-badge-action** runs **setup-badge** workflow below.\n\n1. **setup-badge** runs with [command line options](https://github.com/tagdots/setup-badge-action?tab=readme-ov-file#-setup-badge-command-line-options).\n1. **setup-badge** adds/updates a json file from your options.\n1. **setup-badge** pushes a commit to the remote branch.\n1. **endpoint badge** is created with `shields.io endpoint` and `your json file`.\n\nAfterwards, you can put `endpoint badge` into your README file.\n\n![How It Works](https://raw.githubusercontent.com/tagdots/setup-badge/refs/heads/main/assets/setup-badge.png)\n\n\u003cbr\u003e\n\n## 😎 GitHub Action workflow examples\n\nUse the example workflows below to create your own workflow inside `.github/workflows/`.\n\n\u003cbr\u003e\n\n### Example 1️⃣ - summary\n**setup-badge-action**:\n\n* runs `on demand`\n* creates two static badges: `language` and `license`\n  * language badge does not have a badge url\n  * license badge has a badge url that links to the project's LICENSE file\n\n### Example 1️⃣ - create multiple static badges\n```\nname: setup-badge-action\n\non:\n  workflow_dispatch:\n\npermissions:\n  contents: read\n\njobs:\n  language-badge:\n    runs-on: ubuntu-latest\n\n    permissions:\n      contents: write\n\n    steps:\n    - id: language-badge\n      uses: tagdots/setup-badge-action@663d7a5382b8300caa4492de16e85aa7e4667ef0 # 1.0.3\n      with:\n        badge-name: language\n        label: Language\n        message: Python\n        message-color: FFA500\n\n  license-badge:\n    runs-on: ubuntu-latest\n\n    permissions:\n      contents: write\n\n    steps:\n    - id: license-badge\n      uses: tagdots/setup-badge-action@663d7a5382b8300caa4492de16e85aa7e4667ef0 # 1.0.3\n      with:\n        badge-name: license\n        badge-url: https://raw.githubusercontent.com/tagdots/setup-badge/refs/heads/main/LICENSE\n        label: License\n        message: MIT\n        message-color: FFA500\n```\n\n\u003cbr\u003e\u003cbr\u003e\n\n### Example 2️⃣ - summary\n**setup-badge-action**:\n\n* runs `on schedule at 5:30 pm UTC` or `on demand`\n* runs a coverage test and get the coverage percentage from the test result\n* creates a dynamic `Code Coverage` badge with the coverage % that changes over time\n\n### Example 2️⃣ - create a dynamic badge\n```\nname: setup-badge-action\n\non:\n  schedule:\n    - cron: '30 17 * * *'\n\n  workflow_dispatch:\n\npermissions:\n  contents: read\n\njobs:\n  coverage-badge:\n    runs-on: ubuntu-latest\n\n    permissions:\n      contents: write\n\n    outputs:\n      COV_PER: ${{ steps.get-coverage-results.outputs.COV_PER }}\n\n    steps:\n    - id: coverage-run\n      run: coverage run\n\n    - id: get-coverage-results\n      run: |\n        echo \"COV_PER=$(...coverage run results...)\" \u003e\u003e \"$GITHUB_OUTPUT\"\n\n    - id: coverage-badge\n      uses: tagdots/setup-badge-action@663d7a5382b8300caa4492de16e85aa7e4667ef0 # 1.0.3\n      with:\n        badge-name: coverage\n        label: \"Code Coverage\"\n        message: \"${{ steps.get-coverage-results.outputs.COV_PER }}\"\n```\n\n\u003cbr\u003e\n\n## 🔧 setup-badge command line options\n\n| Input | Description | Default | Notes |\n|-------|-------------|----------|----------|\n| `badge-name` | JSON endpoint filename | `badge` | JSON endpoint filename |\n| `branch-name` | Branch to hold JSON endpoint | `badges` | a single branch can hold multiple JSON endpoint files |\n| `badge-style` | Badge style | `flat` | other options: `flat-square`, `plastic`, `for-the-badge`, `social` |\n| `badge-url` | Badge URL | `''` | no default value (enter a url if necessary) |\n| `label` | Left side text | `demo` | - |\n| `label-color` | Left side background color | `2e2e2e` | hex color |\n| `message` | Right side text | `no status` | place dynamic/static data here |\n| `message-color` | Right side background color | `2986CC` | hex color |\n| `remote-name` | Git remote source branch | `origin` | leave it as-is in general |\n| `gitconfig-name` | Git config user name | `Mona Lisa` | need this option for CI or GitHub action |\n| `gitconfig-email` | Git config user email | `mona.lisa@github.com` | need this option for CI or GitHub action |\n\n\u003cbr\u003e\n\n\n## 😕  Troubleshooting\n\nWe are here to help - open an [issue](https://github.com/tagdots/setup-badge-action/issues)\n\n\u003cbr\u003e\n\n## 🙌 Appreciation\nIf you find this project helpful, please ⭐ star it.  **Thank you**.\n\n\u003cbr\u003e\n\n## 📖 License\n\n[MIT License](https://github.com/tagdots/setup-badge-action/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftagdots%2Fsetup-badge-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftagdots%2Fsetup-badge-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftagdots%2Fsetup-badge-action/lists"}