Create pull_request_template.md #23
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This workflow will install Python dependencies, run tests and lint with a variety of Python versions | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
| name: Test | |
| on: | |
| push: | |
| branches: [ master ] | |
| jobs: | |
| unittest: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [windows-latest, ubuntu-latest] | |
| python-version: [3.7, 3.8, 3.9, "3.10", 3.11, 3.12] | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python ${{ matrix.python-version }} for ${{ matrix.os }} | |
| uses: actions/setup-python@v1 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| - name: Test with pytest | |
| run: | | |
| pip install .[dev,collision] | |
| pip install pytest-timeout | |
| pytest --ignore=roboticstoolbox/blocks --timeout=50 --timeout_method thread -s | |
| codecov: | |
| # If all tests pass: | |
| # Run coverage and upload to codecov | |
| needs: unittest | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python 3.7 | |
| uses: actions/setup-python@v1 | |
| with: | |
| python-version: 3.7 | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| - name: Run coverage | |
| run: | | |
| pip install -e .[dev,collision,vpython] | |
| pytest --ignore=roboticstoolbox/blocks --cov=roboticstoolbox --cov-report xml:coverage.xml | |
| coverage report | |
| - name: upload coverage to Codecov | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| file: ./coverage.xml | |
| sphinx: | |
| # If the above worked: | |
| # Build docs and upload to GH Pages | |
| needs: unittest | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python 3.7 | |
| uses: actions/setup-python@v1 | |
| with: | |
| python-version: 3.7 | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install .[docs] | |
| pip install git+https://github.com/petercorke/sphinx-autorun.git | |
| pip install sympy | |
| sudo apt-get install graphviz | |
| - name: Build docs | |
| run: | | |
| cd docs | |
| make html | |
| # Tell GitHub not to use jekyll to compile the docs | |
| touch build/html/.nojekyll | |
| cd ../ | |
| - name: Commit documentation changes | |
| run: | | |
| git clone https://github.com/petercorke/robotics-toolbox-python.git --branch gh-pages --single-branch gh-pages | |
| cp -r docs/build/html/* gh-pages/ | |
| cd gh-pages | |
| git config --local user.email "action@github.com" | |
| git config --local user.name "GitHub Action" | |
| git add . | |
| git commit -m "Update documentation" -a || true | |
| # The above command will fail if no changes were present, so we ignore | |
| # that. | |
| - name: Push changes | |
| uses: ad-m/github-push-action@master | |
| with: | |
| branch: gh-pages | |
| directory: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} |