https://github.com/xarray-contrib/issue-from-pytest-log
create issues from pytest-reportlog files
https://github.com/xarray-contrib/issue-from-pytest-log
Last synced: 8 months ago
JSON representation
create issues from pytest-reportlog files
- Host: GitHub
- URL: https://github.com/xarray-contrib/issue-from-pytest-log
- Owner: xarray-contrib
- License: mit
- Created: 2022-10-21T12:49:20.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-19T12:28:28.000Z (over 1 year ago)
- Last Synced: 2024-04-24T16:23:56.275Z (over 1 year ago)
- Language: Python
- Size: 29.3 KB
- Stars: 10
- Watchers: 8
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# issue-from-pytest-log
Create an issue for failed tests from a [pytest-reportlog](https://github.com/pytest-dev/pytest-reportlog) file or update an existing one if it already exists.
How this works:
1. `pytest-reportlog` writes a complete and machine-readable log of failed tests.
2. The action extracts the failed tests and creates a report while making sure that it fits into the character limits of github issue forms.
3. The action looks for existing open issues with the configured title and label
a. if one exists: replace the old description with the report
b. if there is none: open a new issue and insert the report
## Usage
To use the `issue-from-pytest-log` action in workflows, simply add a new step:
```yaml
jobs:
my-job:
...
strategy:
fail-fast: false
...
...
- uses: actions/setup-python@v4
with:
python-version: "3.11"
cache: pip
...
- run: <
pip install --upgrade pytest-reportlog
...
- run: <
pytest --report-log pytest-log.jsonl
...
- uses: xarray-contrib/issue-from-pytest-log@main
if: |
failure()
&& ...
with:
log-path: pytest-log.jsonl
```
See [this repository](https://github.com/keewis/reportlog-test/issues) for example issues. For more realistic examples, see
- `xarray` ([workflow](https://github.com/pydata/xarray/blob/main/.github/workflows/upstream-dev-ci.yaml), [example issue](https://github.com/pydata/xarray/issues/6197))
- `dask` ([workflow](https://github.com/dask/dask/blob/main/.github/workflows/upstream.yml), [example issue](https://github.com/dask/dask/issues/10089))
## Options
### log path
required.
Use `log-path` to specify where the output of `pytest-reportlog` is.
### issue title
optional. Default: `⚠️ Nightly upstream-dev CI failed ⚠️`
In case you don't like the default title for new issues, this setting can be used to set a different one:
```yaml
- uses: xarray-contrib/issue-from-pytest-log@v1
with:
log-path: pytest-log.jsonl
issue-title: "Nightly CI failed"
```
The title can also be parametrized, in which case a separate issue will be opened for each variation of the title.
### issue label
optional. Default: `CI`
The label to set on the new issue.
```yaml
- uses: xarray-contrib/issue-from-pytest-log@v1
with:
log-path: pytest-log.jsonl
issue-label: "CI"
```