Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mickaelandrieu/psalm-ga

Psalm Github action
https://github.com/mickaelandrieu/psalm-ga

github-action phpqa psalm

Last synced: 13 days ago
JSON representation

Psalm Github action

Awesome Lists containing this project

README

        

# GithubAction for Psalm

## Usage

You can use it as a Github Action like this:

_.github/main.workflow_
```
workflow "Main" {
on = "push"
resolves = ["Psalm"]
}

action "Psalm" {
uses = "docker://mickaelandrieu/psalm-ga"
secrets = ["GITHUB_TOKEN"]
}
```

_to add specific arguments:_
```diff
workflow "Main" {
on = "push"
resolves = ["Psalm"]
}

action "Psalm" {
uses = "docker://mickaelandrieu/psalm-ga"
secrets = ["GITHUB_TOKEN"]
+ args = "--find-dead-code --threads=8 --diff --diff-methods"
}
```

**You can copy/paste the .github folder (under examples/) to your project and thats all!**

## Docker

A Docker-Image is built automatically and located here:
https://cloud.docker.com/u/mickaelandrieu/repository/docker/mickaelandrieu/psalm-ga

You can run it in any given directory like this:

`docker run --rm -it -w=/app -v ${PWD}:/app mickaelandrieu/psalm-ga:latest`