# pytest-github-actions-annotate-failures
[Pytest](https://pypi.org/project/pytest/) plugin to annotate failed tests with a [workflow command for GitHub Actions](https://help.github.com/en/actions/reference/workflow-commands-for-github-actions)
## Usage
Just install and run pytest with this plugin in your workflow. For example,
```yaml
name: test
on:
push:
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.7
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Install plugin
run: pip install pytest-github-actions-annotate-failures
- run: pytest
```
If your test is running in a Docker container, you have to install this plugin and manually set `GITHUB_ACTIONS` environment variable to `true` inside of Docker container. (For example, `docker-compose run --rm -e GITHUB_ACTIONS=true app -- pytest`)
If your tests are run from a subdirectory of the git repository, you have to set the `PYTEST_RUN_PATH` environment variable to the path of that directory relative to the repository root in order for GitHub to identify the files with errors correctly.
## Screenshot
[](https://gyazo.com/b578304465dd1b755ceb0e04692a57d9)
Raw data
{
"_id": null,
"home_page": "",
"name": "pytest-github-actions-annotate-failures",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "utgwkk <utagawakiki@gmail.com>",
"keywords": "ansible,testing,molecule,plugin",
"author": "",
"author_email": "utgwkk <utagawakiki@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a8/d6/76d074e1e4d78c5144397e6061af29bcc218dbf19bb64b39e5c296bf42f1/pytest-github-actions-annotate-failures-0.2.0.tar.gz",
"platform": null,
"description": "# pytest-github-actions-annotate-failures\n[Pytest](https://pypi.org/project/pytest/) plugin to annotate failed tests with a [workflow command for GitHub Actions](https://help.github.com/en/actions/reference/workflow-commands-for-github-actions)\n\n## Usage\nJust install and run pytest with this plugin in your workflow. For example,\n\n```yaml\nname: test\n\non:\n push:\n\njobs:\n test:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v3\n\n - uses: actions/setup-python@v4\n with:\n python-version: 3.7\n\n - name: Install dependencies\n run: |\n python -m pip install --upgrade pip\n pip install -r requirements.txt\n\n - name: Install plugin\n run: pip install pytest-github-actions-annotate-failures\n\n - run: pytest\n```\n\nIf your test is running in a Docker container, you have to install this plugin and manually set `GITHUB_ACTIONS` environment variable to `true` inside of Docker container. (For example, `docker-compose run --rm -e GITHUB_ACTIONS=true app -- pytest`)\n\nIf your tests are run from a subdirectory of the git repository, you have to set the `PYTEST_RUN_PATH` environment variable to the path of that directory relative to the repository root in order for GitHub to identify the files with errors correctly.\n\n## Screenshot\n[](https://gyazo.com/b578304465dd1b755ceb0e04692a57d9)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "pytest plugin to annotate failed tests with a workflow command for GitHub Actions",
"version": "0.2.0",
"project_urls": {
"changelog": "https://github.com/pytest-dev/pytest-github-actions-annotate-failures/releases",
"homepage": "https://github.com/pytest-dev/pytest-github-actions-annotate-failures",
"repository": "https://github.com/pytest-dev/pytest-github-actions-annotate-failures"
},
"split_keywords": [
"ansible",
"testing",
"molecule",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb869ffd9f10a7ba7387ce4ef4362505d739a48dd988051b41d255eb7f102c17",
"md5": "cf5dbb6519cb2bdeaa7e1c3dbf36c202",
"sha256": "8bcef65fed503faaa0524b59cfeccc8995130972dd7b008d64193cc41b9cde85"
},
"downloads": -1,
"filename": "pytest_github_actions_annotate_failures-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf5dbb6519cb2bdeaa7e1c3dbf36c202",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5496,
"upload_time": "2023-05-04T11:05:15",
"upload_time_iso_8601": "2023-05-04T11:05:15.920695Z",
"url": "https://files.pythonhosted.org/packages/eb/86/9ffd9f10a7ba7387ce4ef4362505d739a48dd988051b41d255eb7f102c17/pytest_github_actions_annotate_failures-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8d676d074e1e4d78c5144397e6061af29bcc218dbf19bb64b39e5c296bf42f1",
"md5": "c070d5da6f9c4029f4d46fc34744b4dd",
"sha256": "844ab626d389496e44f960b42f0a72cce29ae06d363426d17ea9ae1b4bef2288"
},
"downloads": -1,
"filename": "pytest-github-actions-annotate-failures-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "c070d5da6f9c4029f4d46fc34744b4dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9450,
"upload_time": "2023-05-04T11:05:17",
"upload_time_iso_8601": "2023-05-04T11:05:17.080684Z",
"url": "https://files.pythonhosted.org/packages/a8/d6/76d074e1e4d78c5144397e6061af29bcc218dbf19bb64b39e5c296bf42f1/pytest-github-actions-annotate-failures-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-04 11:05:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pytest-dev",
"github_project": "pytest-github-actions-annotate-failures",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "pytest-github-actions-annotate-failures"
}
JSON
