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

🛡⚡️ A README badge service for GitHub Actions
https://github.com/JasonEtco/action-badges

actions badges github now svg

Last synced: about 1 month ago
JSON representation

🛡⚡️ A README badge service for GitHub Actions

• Host: GitHub
• URL: https://github.com/JasonEtco/action-badges
• Owner: JasonEtco
• License: mit
• Archived: true
• Created: 2019-03-02T05:29:22.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-09-07T21:02:12.000Z (over 5 years ago)
• Last Synced: 2024-08-05T09:15:11.162Z (5 months ago)
• Topics: actions, badges, github, now, svg
• Language: JavaScript
• Homepage: https://action-badges.now.sh
• Size: 115 KB
• Stars: 61
• Watchers: 6
• Forks: 42
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
This project is deprecated! Badges are now officially part of the GitHub Actions platform!


Action Badges

A README badge service for GitHub Actions


 


## Usage

Get a status badge for all GitHub Action runs on the `master` branch of a repository:

```md

![badge](https://action-badges.now.sh/JasonEtco/example-repo)

```

Specify an action with the `action` query parameter:

```md

![badge](https://action-badges.now.sh/JasonEtco/example-repo?action=test)

```

**Note:** This service only works for public repositories! It cannot read the status of your private repos.

## How it works

When the `/:owner/:repo` endpoint is requested, the app makes a request to the GitHub API to get the list of check suites created by the GitHub Actions app. It then calculates the status based on the sum conclusion of the check suites and responds with some SVG code (thanks to [badgen](https://github.com/amio/badgen)).