Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jradtilbrook/phpstan-buildkite-plugin
A Buildkite plugin that runs PHPStan and can annotate GitHub checks
https://github.com/jradtilbrook/phpstan-buildkite-plugin
Last synced: about 1 month ago
JSON representation
A Buildkite plugin that runs PHPStan and can annotate GitHub checks
- Host: GitHub
- URL: https://github.com/jradtilbrook/phpstan-buildkite-plugin
- Owner: jradtilbrook
- License: mit
- Created: 2024-10-15T04:33:35.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-15T04:33:37.000Z (3 months ago)
- Last Synced: 2024-11-26T23:37:29.378Z (about 1 month ago)
- Language: Shell
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Template Buildkite Plugin [](https://buildkite.com/buildkite/plugins-template)
A Buildkite plugin for something awesome
## Options
These are all the options available to configure this plugin's behaviour.
### Required
#### `mandatory` (string)
A great description of what this is supposed to do.
### Optional
#### `optional` (string)
Describe how the plugin behaviour changes if this option is not specified, allowed values and its default.
## Examples
Show how your plugin is to be used
```yaml
steps:
- label: "🔨 Running plugin"
command: "echo template plugin"
plugins:
- template#v1.0.0:
mandatory: "value"
```
## And with other options as well
If you want to change the plugin behaviour:
```yaml
steps:
- label: "🔨 Running plugin"
command: "echo template plugin with options"
plugins:
- template#v1.0.0:
mandatory: "value"
optional: "example"
```
## ⚒ Developing
You can use the [bk cli](https://github.com/buildkite/cli) to run the [pipeline](.buildkite/pipeline.yml) locally:
```bash
bk local run
```
## 👩💻 Contributing
Your policy on how to contribute to the plugin!
## 📜 License
The package is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).