README.md

CodeLimit GitHub Action

Your Refactoring Alarm 🔔 As a GitHub Action

To run CodeLimit on every push and before every merge to main, append it to your GH Action workflow:

name: 'main'

on:
  push:
    branches: 
      - main
  pull_request:
    branches: 
      - main

jobs:
  ci:
    runs-on: ubuntu-latest
    steps:
      - name: 'Checkout sources'
        uses: actions/checkout@v4

      - name: 'Run CodeLimit'
        uses: getcodelimit/codelimit-action@v1

Inputs

• token:
  • Description: GitHub token for storing results
  • Required: false
  • Default: ${{ github.token }}
• check:
  • Description: Check changed files
  • Required: false
  • Default: true
• codelimit_version:
  • Desciption: CodeLimit version
  • Required: false
  • Default: 'latest'