Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/annervisser/psalm-baseline-progress-action
A GitHub action that calculates the size of your psalm baseline on a pull request compared to the base branch. This allows you to easily comment the difference on a pull request, or use it in other subsequent actions
https://github.com/annervisser/psalm-baseline-progress-action
github-actions psalm psalm-baseline
Last synced: 11 days ago
JSON representation
A GitHub action that calculates the size of your psalm baseline on a pull request compared to the base branch. This allows you to easily comment the difference on a pull request, or use it in other subsequent actions
- Host: GitHub
- URL: https://github.com/annervisser/psalm-baseline-progress-action
- Owner: annervisser
- License: mit
- Created: 2023-02-15T12:44:12.000Z (over 1 year ago)
- Default Branch: trunk
- Last Pushed: 2024-08-20T09:34:39.000Z (3 months ago)
- Last Synced: 2024-10-12T02:48:12.270Z (27 days ago)
- Topics: github-actions, psalm, psalm-baseline
- Language: Shell
- Homepage:
- Size: 34.2 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Psalm baseline progress
A GitHub action that calculates the size of your psalm baseline.
Allowing you to track the progress of your baseline over time.
The score is the total number of occurrences of `
---
* [Usage](#usage)
* [Inputs](#inputs)
* [Outputs](#outputs)
* [Templates](#templates)
* [Examples](#examples)
* [Comment on pull requests](#comment-on-pull-requests)
* [Fail pull request check if baseline has grown](#fail-pull-request-check-if-baseline-has-grown)
## Usage
### Inputs
> **Note**: All inputs are optional and the defaults should work in most cases
| Input | Default | Description |
|--------------------|-------------------------------------------|--------------------------------------------------------------------------------------|
| base_ref | ${{ github.event.pull_request.base.sha }} | git ref to use for calculating the base_score |
| head_ref | 'HEAD' | git ref to use for calculating the head_score |
| path_to_baseline | './psalm-baseline.xml' | Path to the baseline file |
| template_decreased | See [Templates](#Templates) | Template to use when the baseline has decreased (See [Templates](#Templates)) |
| template_increased | See [Templates](#Templates) | Template to use when the baseline has grown (See [Templates](#Templates)) |
| template_no_change | See [Templates](#Templates) | Template to use when the baseline score hasn't changed (See [Templates](#Templates)) |
### Outputs
| Output | Description |
|-------------------|------------------------------------------------------------------------------|
| base_score | Baseline score at base_ref |
| head_score | Baseline score at head_ref |
| score_diff | Difference between the two scores (head_score - base_score) |
| score_diff_string | Same a `score_diff`, with a `+` prepended for positive numbers |
| output_message | Parsed output based on the `template_*` inputs (See [Templates](#Templates)) |
### Templates
The template_* inputs allow you to specify different templates for when the score increases/decreases/remains the same.
These templates are parsed by `envsubst`, with valid substitutions being: `$BASE_SCORE`, `$HEAD_SCORE`, `$SCORE_DIFF` & `$SCORE_DIFF_STRING`
The relevant template is parsed and output to `output_message` for you to use.
#### Customising the templates
```yaml
- id: baseline-scores
uses: annervisser/psalm-baseline-progress-action@v1
with:
template_decreased: 'Baseline decreased! from $BASE_SCORE to $HEAD_SCORE'
template_increased: |
The baseline has increased!
Old score: $BASE_SCORE
New score: $HEAD_SCORE
Difference: $SCORE_DIFF_STRING
template_no_change: 'Nothing''s changed!'
```
#### The default templates look like this:
- `🍀 Psalm baseline has decreased: **$BASE_SCORE** → **$HEAD_SCORE** _(**${SCORE_DIFF}**)_` \
🍀 Psalm baseline has decreased: **500** → **490** _(**-10**)_
- `📛 Psalm baseline has increased: **$BASE_SCORE** → **$HEAD_SCORE** _(**+${SCORE_DIFF}**)_` \
📛 Psalm baseline has increased: **500** → **510** _(+**10**)_
- `Psalm baseline score remained the same: **$HEAD_SCORE**` \
Psalm baseline score remained the same: **500**
## Examples
### Comment on pull requests
See [Templates](#Templates) for customizing the `output_message`
```yaml
on:
pull_request:
jobs:
test-action:
runs-on: ubuntu-latest
permissions:
contents: read # Default permission when no others are specified, needed for actions/checkout
pull-requests: write # Needed to post a comment on a pull request
steps:
- uses: actions/checkout@v3
- id: baseline-scores
uses: annervisser/psalm-baseline-progress-action@v1
- uses: thollander/actions-comment-pull-request@v2
with:
message: ${{ steps.psalm-baseline-progress-action.outputs.output_message }}
comment_tag: 'psalm_baseline_score_comment'
create_if_not_exists: ${{ steps.psalm-baseline-progress-action.outputs.score_diff != 0 }} # Only create comment when baseline score changed, but always update existing comment
# GITHUB_TOKEN: # Only needed to comment on pull requests coming from forks
```
### Fail pull request check if baseline has grown
```yaml
on:
pull_request:
jobs:
test-action:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- id: baseline-scores
uses: annervisser/psalm-baseline-progress-action@v1
- if: steps.baseline-scores.outputs.score_diff > 0
run: |
echo ::error::Baseline has grown by ${{ steps.baseline-scores.score_diff }}
exit 1
```