https://github.com/novusvetus/action-phpinsights

GitHub phpinsights action. This workflow check the PHP files for the wanted coding standards and security issues.
https://github.com/novusvetus/action-phpinsights

codechecker codequality codereview github github-action github-actions hacktoberfest insights marketplace marketplace-released php php7 php8 phpinsights security workflow workflows

Last synced: 9 days ago
JSON representation

GitHub phpinsights action. This workflow check the PHP files for the wanted coding standards and security issues.

• Host: GitHub
• URL: https://github.com/novusvetus/action-phpinsights
• Owner: Novusvetus
• License: bsd-3-clause
• Created: 2021-10-12T18:16:07.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T04:31:12.000Z (7 months ago)
• Last Synced: 2024-10-13T13:09:36.020Z (24 days ago)
• Topics: codechecker, codequality, codereview, github, github-action, github-actions, hacktoberfest, insights, marketplace, marketplace-released, php, php7, php8, phpinsights, security, workflow, workflows
• Language: TypeScript
• Homepage:
• Size: 3.02 MB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# GitHub Action to run PHP Insights

## Overview

This action runs [PHP Insights](https://github.com/nunomaduro/phpinsights).

## Usage

Add a file like this to `.github/workflows/phpinsights.yml`:

```yml

name: "CI"

on:

  push:

    paths:

      - "**.php"

      - ".github/workflows/phpinsights.yml"

  pull_request:

    paths:

      - "**.php"

      - ".github/workflows/phpinsights.yml"

jobs:

  phpinsights:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

        with:

          fetch-depth: 0 # important!

      - name: Install PHP Insights

        run: |

          curl -OL https://getcomposer.org/download/latest-2.x/composer.phar

          php composer.phar global config --no-plugins allow-plugins.dealerdirect/phpcodesniffer-composer-installer true

          php composer.phar global require nunomaduro/phpinsights

          php composer.phar clearcache -q

          php ~/.composer/vendor/bin/phpinsights --version

      - uses: Novusvetus/[email protected]

        with:

          files: "**.php"

          scan_all: true

          phpinsights_path: "php ~/.composer/vendor/bin/phpinsights"

          min_quality: 90

          min_complexity: 90

          min_architecture: 90

          min_style: 90

```

## License ##

3-clause BSD license

See [License](LICENSE)

## Bugtracker ##

Bugs are tracked in the issues section of this repository on GitHub.

Please read over existing issues before submitting an issue to ensure yours is unique.

[Create a new issue](../../issues/new)

 - Describe the steps to reproduce your issue.

 - Describe the expected and the actual outcome.

 - Describe your environment as detailed as possible.

## Development and contribution ##

Feature requests can also be made by [creating a new issue](../../issues/new).

If you would like to make contributions to this repository, feel free to [create a fork](../../fork) and submit a pull request.

## Links ##

* [ReindeerWeb](https://www.reindeer-web.de)

* [Novusvetus](https://www.novusvetus.de)

* [License](./LICENSE)

* [Contributing](./CONTRIBUTING.md)