Skip to content

Commit

Permalink
Merge pull request #62 from pytest-dev/github-actions
Browse files Browse the repository at this point in the history
 Replace template CI from AppVeyor -> GitHub Actions
  • Loading branch information
bluetech authored Jan 20, 2024
2 parents c343a9a + 0ce0aaa commit c906239
Show file tree
Hide file tree
Showing 13 changed files with 58 additions and 49 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ pytest-awesome/
option
- Comprehensive `README.rst` file that contains useful information about your
plugin
- Continuous integration configuration for [AppVeyor]
- Continuous integration configuration for [GitHub Actions]
- Optional documentation with either [Sphinx] or [MkDocs]
- Choose from several licenses, such as [MIT], [BSD-3], [Apache v2.0], [GNU GPL
v3.0+], or [MPL v2.0]
Expand Down Expand Up @@ -126,16 +126,16 @@ Plugin is free and open source software.
[tox]: https://tox.readthedocs.io/en/latest/
[Submit a Plugin]: https://docs.pytest.org/en/latest/contributing.html#submitting-plugins-to-pytest-dev
[pytest hook reference]: https://docs.pytest.org/en/latest/writing_plugins.html#pytest-hook-reference
[MIT license]: http://opensource.org/licenses/MIT
[MIT license]: https://opensource.org/licenses/MIT
[file an issue]: https://github.com/pytest-dev/cookiecutter-pytest-plugin/issues
[Sphinx]: http://sphinx-doc.org/
[MkDocs]: http://www.mkdocs.org/
[MIT]: http://opensource.org/licenses/MIT
[Sphinx]: https://sphinx-doc.org/
[MkDocs]: https://www.mkdocs.org/
[MIT]: https://opensource.org/licenses/MIT
[MPL v2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
[BSD-3]: http://opensource.org/licenses/BSD-3-Clause
[GNU GPL v3.0+]: http://www.gnu.org/licenses/gpl-3.0.txt
[Apache v2.0]: http://www.apache.org/licenses/LICENSE-2.0
[AppVeyor]: http://www.appveyor.com/
[BSD-3]: https://opensource.org/licenses/BSD-3-Clause
[GNU GPL v3.0+]: https://www.gnu.org/licenses/gpl-3.0.txt
[Apache v2.0]: https://www.apache.org/licenses/LICENSE-2.0
[GitHub Actions]: https://docs.github.com/en/actions
[PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
[Shortbread]: https://github.com/audreyr/cookiecutter/releases/tag/1.4.0
[osi_certified]: https://opensource.org/trademarks/osi-certified/web/osi-certified-120x100.png
Expand Down
2 changes: 1 addition & 1 deletion docs/contributor-guide/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ The plugin source code can always use more documentation.

Please add doc strings and regular Python comments to the actual plugin code.

[jinja2 comments]: http://jinja.pocoo.org/docs/dev/templates/#comments
[jinja2 comments]: https://jinja.palletsprojects.com/en/3.0.x/templates/#comments
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Plugin is free and open source software
[gitter]: https://gitter.im/pytest-dev/cookiecutter-pytest-plugin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge (Join Chat on Gitter.im)
[docs_badge]: https://readthedocs.org/projects/cookiecutter-pytest-plugin/badge/?version=latest
[documentation]: https://readthedocs.org/projects/cookiecutter-pytest-plugin/?badge=latest (Documentation Status)
[MIT license]: http://opensource.org/licenses/MIT
[MIT license]: https://opensource.org/licenses/MIT
[file an issue]: https://github.com/pytest-dev/cookiecutter-pytest-plugin/issues


Expand Down
29 changes: 29 additions & 0 deletions pytest-{{cookiecutter.plugin_name}}/.github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: main

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
include:
- python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', 'pypy-3.8']
steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: {% raw -%}${{ matrix.python-version }}{% endraw %}

- name: Install tox
run: pip install tox

- name: Test
run: tox -e py
14 changes: 7 additions & 7 deletions pytest-{{cookiecutter.plugin_name}}/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
:target: https://pypi.org/project/pytest-{{cookiecutter.plugin_name}}
:alt: Python versions

.. image:: https://ci.appveyor.com/api/projects/status/github/{{cookiecutter.github_username}}/pytest-{{cookiecutter.plugin_name}}?branch=master
:target: https://ci.appveyor.com/project/{{cookiecutter.github_username}}/pytest-{{cookiecutter.plugin_name}}/branch/master
:alt: See Build Status on AppVeyor
.. image:: https://github.com/{{cookiecutter.github_username}}/pytest-{{cookiecutter.plugin_name}}/actions/workflows/main.yml/badge.svg
:target: https://github.com/{{cookiecutter.github_username}}/pytest-{{cookiecutter.plugin_name}}/actions/workflows/main.yml
:alt: See Build Status on GitHub Actions

{{cookiecutter.short_description}}

Expand Down Expand Up @@ -64,10 +64,10 @@ If you encounter any problems, please `file an issue`_ along with a detailed des

.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
.. _`@hackebrot`: https://github.com/hackebrot
.. _`MIT`: http://opensource.org/licenses/MIT
.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause
.. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt
.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
.. _`MIT`: https://opensource.org/licenses/MIT
.. _`BSD-3`: https://opensource.org/licenses/BSD-3-Clause
.. _`GNU GPL v3.0`: https://www.gnu.org/licenses/gpl-3.0.txt
.. _`Apache Software License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin
.. _`file an issue`: https://github.com/{{cookiecutter.github_username}}/pytest-{{cookiecutter.plugin_name}}/issues
.. _`pytest`: https://github.com/pytest-dev/pytest
Expand Down
20 changes: 0 additions & 20 deletions pytest-{{cookiecutter.plugin_name}}/appveyor.yml

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ BUILDDIR = _build

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://sphinx-doc.org/)
endif

# Internal variables.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ if errorlevel 9009 (
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
echo.https://sphinx-doc.org/
exit /b 1
)

Expand Down
2 changes: 1 addition & 1 deletion pytest-{{cookiecutter.plugin_name}}/licenses/Apache-2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{#- source: http://www.apache.org/licenses/LICENSE-2.0 #}
{#- source: https://www.apache.org/licenses/LICENSE-2.0 #}
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
Expand Down
2 changes: 1 addition & 1 deletion pytest-{{cookiecutter.plugin_name}}/licenses/BSD-3
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{#- source: http://opensource.org/licenses/BSD-3-Clause #}
{#- source: https://opensource.org/licenses/BSD-3-Clause #}
Copyright (c) {% now 'utc', '%Y' %}, {{cookiecutter.full_name}}
All rights reserved.

Expand Down
10 changes: 5 additions & 5 deletions pytest-{{cookiecutter.plugin_name}}/licenses/GPL-3
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{# source: http://www.gnu.org/licenses/gpl-3.0.txt #}
{# source: https://www.gnu.org/licenses/gpl-3.0.txt #}
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

Expand Down Expand Up @@ -646,7 +646,7 @@ the "copyright" line and a pointer to where the full notice is found.
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
along with this program. If not, see <https://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

Expand All @@ -665,11 +665,11 @@ might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
<https://www.gnu.org/licenses/>.

The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
<https://www.gnu.org/philosophy/why-not-lgpl.html>.
2 changes: 1 addition & 1 deletion pytest-{{cookiecutter.plugin_name}}/licenses/MIT
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{#- source: http://opensource.org/licenses/MIT #}
{#- source: https://opensource.org/licenses/MIT #}
The MIT License (MIT)

Copyright (c) {% now 'utc', '%Y' %} {{cookiecutter.full_name}}
Expand Down
2 changes: 1 addition & 1 deletion pytest-{{cookiecutter.plugin_name}}/licenses/MPL-2
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ Exhibit A - Source Code Form License Notice

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
file, You can obtain one at https://mozilla.org/MPL/2.0/.

If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
Expand Down

0 comments on commit c906239

Please sign in to comment.