Skip to content

hugoschool/cs2-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cs2-action

Runs and checks if your code is compliant to Epitech's Coding Style

Usage

A typical GitHub workflow would work like that:

on:
  push:

jobs:
  check-coding-style:
    runs-on: ubuntu-latest
    name: Check Coding Style
    steps:
      - uses: actions/checkout@v5
      - uses: hugoschool/cs2-action@v1

This runs cs2 at the root of your repo and reports all the Coding Style errors in a GitHub friendly way.

Options

  • install_only: Doesn't run cs2, only installs it for you
  • compile_source: Compile cs2 from source instead of downloading latest release
  • ref: Only works with compile_source input, specify which ref (commit, branch, tag) to compile from
  • path: Run cs2 in this directory
  • options: Run cs2 with these options (example: -j2)

Checkout action.yml for more information.

Using options is done with the with keyword:

# ...
steps:
    - uses: actions/checkout@v5
    - uses: hugoschool/cs2-action@v1
      with:
        path: tests/
        install_only: true

About

:octocat: EXTRAS: Runs and checks if your code is compliant to Epitech's Coding Style

Resources

License

Stars

Watchers

Forks

Packages

No packages published