From bf745726be29a99a5b8f72e8376cd44be9c37d66 Mon Sep 17 00:00:00 2001 From: Parth Shandilya Date: Tue, 1 Dec 2020 15:00:31 +0100 Subject: [PATCH] global: migrate CI to GH Actions closes #219 --- .editorconfig | 4 +- .github/workflows/pypi-release.yml | 37 ++++++++++++ .github/workflows/tests.yml | 96 ++++++++++++++++++++++++++++++ .travis.yml | 79 ------------------------ CONTRIBUTING.rst | 4 +- MANIFEST.in | 1 + README.rst | 4 +- pytest.ini | 3 +- run-tests.sh | 15 +++-- setup.py | 13 +--- 10 files changed, 153 insertions(+), 103 deletions(-) create mode 100644 .github/workflows/pypi-release.yml create mode 100644 .github/workflows/tests.yml delete mode 100644 .travis.yml diff --git a/.editorconfig b/.editorconfig index 16064322..920529c6 100644 --- a/.editorconfig +++ b/.editorconfig @@ -34,8 +34,8 @@ indent_size = 4 [*.{css,html,js,json,yml}] indent_size = 2 -# Matches the exact files either package.json or .travis.yml -[{package.json,.travis.yml}] +# Matches the exact files either package.json or .github/workflows/*.yml +[{package.json,.github/workflows/*.yml}] indent_size = 2 # Dockerfile diff --git a/.github/workflows/pypi-release.yml b/.github/workflows/pypi-release.yml new file mode 100644 index 00000000..0fb53930 --- /dev/null +++ b/.github/workflows/pypi-release.yml @@ -0,0 +1,37 @@ +name: Publish + +on: + push: + tags: + - v* + +jobs: + Publish: + + runs-on: ubuntu-20.04 + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.7 + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install setuptools wheel + + - name: Build package + # Remove `compile_catalog` if the package has no translations. + run: | + python setup.py compile_catalog sdist bdist_wheel + + - name: Publish on PyPI + uses: pypa/gh-action-pypi-publish@v1.3.1 + with: + user: __token__ + # The token is provided by the inveniosoftware organization + password: ${{ secrets.pypi_token }} diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 00000000..e7a00123 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,96 @@ +name: CI + +on: + push: + branches: master + pull_request: + branches: master + schedule: + # * is a special character in YAML so you have to quote this string + - cron: '0 3 * * 6' + workflow_dispatch: + inputs: + reason: + description: 'Reason' + required: false + default: 'Manual trigger' + +jobs: + Tests: + runs-on: ubuntu-20.04 + strategy: + matrix: + python-version: [3.6, 3.7, 3.8] + requirements-level: [min, pypi] + db-service: [postgresql9, postgresql11, mysql5, mysql8] + + exclude: + - python-version: 3.8 + requirements-level: min + + - db-service: postgresql11 + python-version: 3.6 + + - db-service: mysql8 + python-version: 3.6 + + include: + - db-service: postgresql9 + DB: postgresql + POSTGRESQL_VERSION: POSTGRESQL_9_LATEST + SQLALCHEMY_DATABASE_URI: "postgresql+psycopg2://invenio:invenio@localhost:5432/invenio" + EXTRAS: "all,postgresql" + + - db-service: postgresql11 + DB: postgresql + POSTGRESQL_VERSION: POSTGRESQL_11_LATEST + SQLALCHEMY_DATABASE_URI: "postgresql+psycopg2://invenio:invenio@localhost:5432/invenio" + EXTRAS: "all,postgresql" + + - db-service: mysql5 + DB: mysql + MYSQL_VERSION: MYSQL_5_LATEST + SQLALCHEMY_DATABASE_URI: "mysql+pymysql://invenio:invenio@localhost:3306/invenio" + EXTRAS: "all,mysql" + + - db-service: mysql8 + DB: mysql + MYSQL_VERSION: MYSQL_8_LATEST + SQLALCHEMY_DATABASE_URI: "mysql+pymysql://invenio:invenio@localhost:3306/invenio" + EXTRAS: "all,mysql" + + env: + SQLALCHEMY_DATABASE_URI: ${{matrix.SQLALCHEMY_DATABASE_URI}} + POSTGRESQL_VERSION: ${{matrix.POSTGRESQL_VERSION}} + MYSQL_VERSION: ${{matrix.MYSQL_VERSION}} + DB: ${{ matrix.DB }} + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + + - name: Generate dependencies + run: | + python -m pip install --upgrade pip setuptools py wheel requirements-builder + requirements-builder -e ${{ matrix.EXTRAS }} ${{ matrix.requirements-file }} --level=${{ matrix.requirements-level }} setup.py > .${{ matrix.requirements-level }}-${{ matrix.python-version }}-requirements.txt + + - name: Cache pip + uses: actions/cache@v2 + with: + path: ~/.cache/pip + key: ${{ runner.os }}-pip-${{ hashFiles('.${{ matrix.requirements-level }}-${{ matrix.python-version }}-requirements.txt') }} + + - name: Install dependencies + run: | + pip install -r .${{matrix.requirements-level}}-${{ matrix.python-version }}-requirements.txt + pip install .[${{ matrix.EXTRAS }}] + pip freeze + + - name: Run tests + run: | + ./run-tests.sh diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index e7b47fd2..00000000 --- a/.travis.yml +++ /dev/null @@ -1,79 +0,0 @@ -# -*- coding: utf-8 -*- -# -# This file is part of Invenio. -# Copyright (C) 2015-2018 CERN. -# -# Invenio is free software; you can redistribute it and/or modify it -# under the terms of the MIT License; see LICENSE file for more details. - -addons: - postgresql: 9.4 - -notifications: - email: false - -dist: xenial - -language: python - -matrix: - fast_finish: true - allow_failures: - - env: REQUIREMENTS=devel EXTRAS=all,sqlite SQLALCHEMY_DATABASE_URI="sqlite:///test.db" - - env: REQUIREMENTS=devel EXTRAS=all,mysql SQLALCHEMY_DATABASE_URI="mysql+pymysql://root@localhost:3306/invenio" - - env: REQUIREMENTS=devel EXTRAS=all,postgresql SQLALCHEMY_DATABASE_URI="postgresql+psycopg2://postgres@localhost:5432/invenio" - - python: "3.8" - -cache: - - pip - -services: - - mysql - - postgresql - - redis - -env: - - REQUIREMENTS=lowest EXTRAS=all,sqlite SQLALCHEMY_DATABASE_URI="sqlite:///test.db" - - REQUIREMENTS=lowest EXTRAS=all,mysql SQLALCHEMY_DATABASE_URI="mysql+pymysql://root@localhost:3306/invenio" - - REQUIREMENTS=lowest EXTRAS=all,postgresql SQLALCHEMY_DATABASE_URI="postgresql+psycopg2://postgres@localhost:5432/invenio" - - REQUIREMENTS=release EXTRAS=all,sqlite SQLALCHEMY_DATABASE_URI="sqlite:///test.db" - - REQUIREMENTS=release EXTRAS=all,mysql SQLALCHEMY_DATABASE_URI="mysql+pymysql://root@localhost:3306/invenio" - - REQUIREMENTS=release EXTRAS=all,postgresql SQLALCHEMY_DATABASE_URI="postgresql+psycopg2://postgres@localhost:5432/invenio" DEPLOY=true - - REQUIREMENTS=devel EXTRAS=all,sqlite SQLALCHEMY_DATABASE_URI="sqlite:///test.db" - - REQUIREMENTS=devel EXTRAS=all,mysql SQLALCHEMY_DATABASE_URI="mysql+pymysql://root@localhost:3306/invenio" - - REQUIREMENTS=devel EXTRAS=all,postgresql SQLALCHEMY_DATABASE_URI="postgresql+psycopg2://postgres@localhost:5432/invenio" - -python: - - "3.6" - - "3.7" - - "3.8" - -before_install: - - "travis_retry pip install --upgrade pip setuptools py" - - "travis_retry pip install twine wheel coveralls requirements-builder" - - "requirements-builder -e $EXTRAS --level=min setup.py > .travis-lowest-requirements.txt" - - "requirements-builder -e $EXTRAS --level=pypi setup.py > .travis-release-requirements.txt" - - "requirements-builder -e $EXTRAS --level=dev --req requirements-devel.txt setup.py > .travis-devel-requirements.txt" - - "mysql -e 'CREATE DATABASE IF NOT EXISTS invenio;' -uroot" - - "psql -c 'CREATE DATABASE invenio;' -U postgres" - -install: - - "travis_retry pip install -r .travis-${REQUIREMENTS}-requirements.txt" - - "travis_retry pip install -e .[${EXTRAS}]" - - "pip freeze" - -script: - - "./run-tests.sh" - -after_success: - - coveralls - -deploy: - provider: pypi - user: inveniosoftware - password: - secure: "UowdMzkUcsd6JBguR6nO71yA+BldcCYNbp/16rnGzprvYnju1WA6UCNZ2VjN7uQLlDXKml61n75otjf9Mo6QsxGbWq1f+d8bgiYF8ffekUiLrBPIQfg6f7uTQYGE0HTRTi6rsLoBW/03MELXk6DvHc9yKvxDET//VaMPaewXj+5ENT3TZnv8b/MSaoHGFOD4ozUPAYtXbtSu7rl+Y/rdOAmwTgMXDeXdjNN2m6DhTLVBYRIGr6UnoE/8hHQd+GimFJpdYb2BUZywmoZAO6lmY8PEy5ArQIMtFZNxYriRysmceE6msZECw17gjYGPhiP4s93pToiQY6bHe8SHlhbz9hLBZT0F9jabLiH1gwAyRF6HDY/BSo1szZvIrFryhXl36xpDfBs59ZSJGKvhP4OkjC4UJ2KLnLIdoonKTZQuBSlbt+P3eQX5V3GwU59o6I0PeFbhw88TemM8/cskjgU+mhDjgTjHAJ7PWwy4+51FlLhzpIqH+U9otYQCn+Y7xOTdNJCyA2x6cZWz+vRS9HdCJqu7qxF+vtI+lHVPYNSC+jYyaty2z4jbfl8yigynjtWspzjG2qgJhbwAmtTR4T3oMfwBwcJl0+kC9Mkjx4KUZDZii3Oyt80i4uZqATj0He0u92dejyCxw2p3Zs6EpTwYpL+8GLa2MuxTd9EtmefqYEs=" - distributions: "sdist bdist_wheel" - skip_existing: true - on: - tags: true diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 37699647..687b4a2d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -115,6 +115,6 @@ Before you submit a pull request, check that it meets these guidelines: 1. The pull request should include tests and must not decrease test coverage. 2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring. -3. The pull request should work for Python 2.7, 3.3, 3.4 and 3.5. Check - https://travis-ci.com/inveniosoftware/invenio-oauth2server/pull_requests +3. The pull request should work for Python 3.6, 3.7 and 3.8. Check + https://github.com/inveniosoftware/invenio-oauth2server/actions?query=event%3Apull_request and make sure that the tests pass for all supported Python versions. diff --git a/MANIFEST.in b/MANIFEST.in index 109714b7..f8d99f8c 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -25,6 +25,7 @@ recursive-include examples *.py recursive-include examples *.txt recursive-include examples *.html recursive-include examples *.sh +recursive-include .github/workflows *.yml recursive-include invenio_oauth2server *.html recursive-include invenio_oauth2server *.mo recursive-include invenio_oauth2server *.po diff --git a/README.rst b/README.rst index aafe061a..c2af3dc3 100644 --- a/README.rst +++ b/README.rst @@ -12,8 +12,8 @@ .. image:: https://img.shields.io/github/license/inveniosoftware/invenio-oauth2server.svg :target: https://github.com/inveniosoftware/invenio-oauth2server/blob/master/LICENSE -.. image:: https://img.shields.io/travis/inveniosoftware/invenio-oauth2server.svg - :target: https://travis-ci.org/inveniosoftware/invenio-oauth2server +.. image:: https://github.com/inveniosoftware/invenio-oauth2server/workflows/CI/badge.svg + :target: https://github.com/inveniosoftware/invenio-oauth2server/actions .. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-oauth2server.svg :target: https://coveralls.io/r/inveniosoftware/invenio-oauth2server diff --git a/pytest.ini b/pytest.ini index f23426e6..56e2d59d 100644 --- a/pytest.ini +++ b/pytest.ini @@ -7,4 +7,5 @@ # under the terms of the MIT License; see LICENSE file for more details. [pytest] -addopts = --pep8 --ignore=docs --cov=invenio_oauth2server --cov-report=term-missing +addopts = --isort --pydocstyle --pycodestyle --doctest-glob="*.rst" --doctest-modules --cov=invenio_oauth2server --cov-report=term-missing tests invenio_oauth2server +testpaths = tests invenio_oauth2server diff --git a/run-tests.sh b/run-tests.sh index c3ad65e1..0a0820c1 100755 --- a/run-tests.sh +++ b/run-tests.sh @@ -6,10 +6,15 @@ # Invenio is free software; you can redistribute it and/or modify it # under the terms of the MIT License; see LICENSE file for more details. +# Quit on errors +set -o errexit -pydocstyle invenio_oauth2server && \ -isort -rc -c -df **/*.py && \ -check-manifest --ignore ".travis-*" && \ -sphinx-build -qnNW docs docs/_build/html && \ -python setup.py test && \ +# Quit on unbound symbols +set -o nounset + +pydocstyle invenio_oauth2server +isort -rc -c -df **/*.py +check-manifest --ignore ".travis-*" +sphinx-build -qnNW docs docs/_build/html +python setup.py test sphinx-build -qnNW -b doctest docs docs/_build/doctest diff --git a/setup.py b/setup.py index e24d5371..00779945 100644 --- a/setup.py +++ b/setup.py @@ -16,18 +16,7 @@ history = open('CHANGES.rst').read() tests_require = [ - 'SQLAlchemy-Continuum>=1.2.1', - 'check-manifest>=0.25', - 'coverage>=4.0', - 'invenio-assets>=1.0.0', - 'invenio-i18n>=1.0.0', - 'invenio-theme>=1.0.0', - 'isort>=4.2.2', - 'mock>=1.3.0', - 'pydocstyle>=1.0.0', - 'pytest-cov>=1.8.0', - 'pytest-pep8>=1.0.6', - 'pytest>=3.8.0,<5.0.0', + 'pytest-invenio>=1.4.0', ] extras_require = {