1- # Python Testing Action - Usage Guide
1+ # Python Unit Testing Action - Usage Guide
22
3- This guide provides detailed information on using the Python Testing GitHub Action.
3+ This guide provides detailed information on using the Python Unit Testing GitHub Action.
44
55## Table of Contents
66
2424 runs-on : ubuntu-latest
2525 steps :
2626 - uses : actions/checkout@v4
27- - uses : thoughtparametersllc/python-testing@v1
27+ - uses : thoughtparametersllc/python-unit- testing@v1
2828` ` `
2929
3030That's it! The action will install pytest and run your tests.
@@ -39,7 +39,7 @@ The action installs and runs pytest with your specified options.
3939
4040**Example configuration:**
4141` ` ` yaml
42- - uses : thoughtparametersllc/python-testing@v1
42+ - uses : thoughtparametersllc/python-unit- testing@v1
4343 with :
4444 pytest-options : ' --cov=mypackage --cov-report=xml'
4545` ` `
@@ -51,7 +51,7 @@ The action installs and runs pytest with your specified options.
5151Specify the Python version to use:
5252
5353` ` ` yaml
54- - uses : thoughtparametersllc/python-testing@v1
54+ - uses : thoughtparametersllc/python-unit- testing@v1
5555 with :
5656 python-version : ' 3.11'
5757` ` `
@@ -61,7 +61,7 @@ Specify the Python version to use:
6161Install additional dependencies before running tests:
6262
6363` ` ` yaml
64- - uses : thoughtparametersllc/python-testing@v1
64+ - uses : thoughtparametersllc/python-unit- testing@v1
6565 with :
6666 requirements-file : ' requirements-dev.txt'
6767` ` `
@@ -71,7 +71,7 @@ Install additional dependencies before running tests:
7171Pass custom options to pytest:
7272
7373` ` ` yaml
74- - uses : thoughtparametersllc/python-testing@v1
74+ - uses : thoughtparametersllc/python-unit- testing@v1
7575 with :
7676 pytest-options : ' --cov --cov-report=xml --maxfail=1'
7777` ` `
9292 steps :
9393 - uses : actions/checkout@v4
9494
95- - uses : thoughtparametersllc/python-testing@v1
95+ - uses : thoughtparametersllc/python-unit- testing@v1
9696 with :
9797 commit-badges : ' true'
9898 badges-directory : ' .github/badges'
@@ -124,7 +124,7 @@ jobs:
124124
125125 steps :
126126 - uses : actions/checkout@v4
127- - uses : thoughtparametersllc/python-testing@v1
127+ - uses : thoughtparametersllc/python-unit- testing@v1
128128 with :
129129 python-version : ${{ matrix.python-version }}
130130` ` `
@@ -145,7 +145,7 @@ jobs:
145145
146146 steps :
147147 - uses : actions/checkout@v4
148- - uses : thoughtparametersllc/python-testing@v1
148+ - uses : thoughtparametersllc/python-unit- testing@v1
149149 with :
150150 python-version : ${{ matrix.python-version }}
151151` ` `
@@ -155,7 +155,7 @@ jobs:
155155Generate coverage reports with pytest:
156156
157157` ` ` yaml
158- - uses : thoughtparametersllc/python-testing@v1
158+ - uses : thoughtparametersllc/python-unit- testing@v1
159159 with :
160160 pytest-options : ' --cov=mypackage --cov-report=xml --cov-report=html'
161161
@@ -170,7 +170,7 @@ Generate coverage reports with pytest:
170170Run different options on different branches:
171171
172172` ` ` yaml
173- - uses : thoughtparametersllc/python-testing@v1
173+ - uses : thoughtparametersllc/python-unit- testing@v1
174174 with :
175175 pytest-options : ${{ github.ref == 'refs/heads/main' && '--cov --slow' || '--fast' }}
176176` ` `
@@ -238,4 +238,4 @@ See the [.github/workflows/](./../workflows/) directory for example workflow con
238238If you need help :
239239- Check the [README](../../README.md)
240240- Review [example workflows](./../workflows/)
241- - [Open an issue](https://github.com/thoughtparametersllc/python-testing/issues)
241+ - [Open an issue](https://github.com/thoughtparametersllc/python-unit- testing/issues)
0 commit comments