https://github.com/guibranco/github-badges-action

📄 :octocat: GitHub Action to update readme with badges
https://github.com/guibranco/github-badges-action

actions badges gh-actions github github-actions profile readme shields-io shieldsio skills

Last synced: 3 months ago
JSON representation

📄 :octocat: GitHub Action to update readme with badges

• Host: GitHub
• URL: https://github.com/guibranco/github-badges-action
• Owner: guibranco
• License: mit
• Created: 2024-09-07T21:15:15.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-28T18:18:44.000Z (4 months ago)
• Last Synced: 2024-09-29T23:23:34.869Z (4 months ago)
• Topics: actions, badges, gh-actions, github, github-actions, profile, readme, shields-io, shieldsio, skills
• Language: TypeScript
• Homepage: https://guibranco.github.io/github-badges-action/
• Size: 524 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Badges Action

[![GitHub repo](https://img.shields.io/badge/GitHub-guibranco%2Fgithub--badges--action-green.svg?style=plastic&logo=github)](https://github.com/guibranco/github-badges-action)

[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/guibranco/github-badges-action?color=green&label=Code%20size&style=plastic&logo=github)](https://github.com/guibranco/github-badges-action)

[![GitHub last commit](https://img.shields.io/github/last-commit/guibranco/github-badges-action?color=green&logo=github&style=plastic&label=Last%20commit)](https://github.com/guibranco/github-badges-action)

[![GitHub license](https://img.shields.io/github/license/guibranco/github-badges-action?color=green&logo=github&style=plastic&label=License)](https://github.com/guibranco/github-badges-action)

[![GitHub Super-Linter](https://github.com/guibranco/github-badges-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)

![CI](https://github.com/guibranco/github-badges-action/actions/workflows/ci.yml/badge.svg)

[![Check dist/](https://github.com/guibranco/github-badges-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/guibranco/github-badges-action/actions/workflows/check-dist.yml)

[![CodeQL](https://github.com/guibranco/github-badges-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/guibranco/github-badges-action/actions/workflows/codeql-analysis.yml)

[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)

📄 :octocat: GitHub Action to update readme with badges (using

[ShieldsIo](https://shields.io) and [SimpleIcons](https://simpleicons.org/) for

icons).

Set skills with categories in a `.json` file in your repository, and then run

this action to create a [Shields.io](https://shields.io/) badge with

[SimpleIcons](https://simpleicons.org/) labels.

Input: `{ "slug": "github" }`

Output:

![GitHub](https://img.shields.io/badge/-GitHub-black?style=badge&logo=github)

## Usage

- `input` (optional). The source file for the skills. **Default:**

  `.github/automations/badges.json`.

- `output` (optional). The destination file for the replacement. **Default:**

  `README.md`.

- `create-pr` (optional). Optionally creates a pull request instead of direct

  commit and push. **Default:** `false`.

- `branch` (optional). Optionally, find `input` and `output` files from a

  specific branch. **Default:** `main` (the repository default branch).

- `section-name` (optional). Optionally set the section name for replacement in

  the `output` file. **Default:** `skills-badges`. This is useful when multiple

  sections are in the same file for different results.

## Outputs

None.

## Example

```yml

name: 'Update skills badges'

on:

  schedule:

    - cron: '0 0 1 * *' # runs every first day of each month, at 00h00.

  workflow_dispatch: # runs via workflow dispatch (manually).

  jobs:

    update-badges:

      runs-on: ubuntu-latest

      permissions:

        contents: write

        pull-requests: write

      steps:

        - uses: actions/checkout@v4

        - name: Run the action

          uses: guibranco/github-badges-action@latest

```

## Sample result

![sample result](github-badges-action-sample-result.png)