Lukasss93 / phpinsights-badger-action

PhpInsights badges generator!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

🛡 PhpInsights Badger

GitHub Action for generating PhpInsights badges!

⚠ The generated badges are self-hosted by using this Lumen Service.

Demo badges

Code Complexity Architecture Style SecurityIssues

Usage

Generate badges on push event:

name: Generate badges
on:
  push:

jobs:
  badges:
    name: Generating badges
    runs-on: ubuntu-latest
    steps:
      - name: Generate PhpInsights badges
        uses: Lukasss93/phpinsights-badger@v1
        with:
          url: 'https://yourservice.com' # Required: your lumen service url 
          password: ${{ secrets.password }} # Required: your lumen service password 
          path : './test.json' # Required: the test.json generated file path from phpinsights

Inputs variables

  • url required string - Your lumen service url
  • password required string - Your lumen service password
  • path required string - The test.json generated file path from phpinsights

Getting generated badges

url badge
https://yourservice.com/author/repo/code Code
https://yourservice.com/author/repo/complexity Complexity
https://yourservice.com/author/repo/architecture Architecture
https://yourservice.com/author/repo/style Style
https://yourservice.com/author/repo/security_issues SecurityIssues

Badge styles

Check the styles section on https://shields.io/

About

PhpInsights badges generator!


Languages

Language:JavaScript 100.0%