From 6d3a67862ad465af100cf34a42dd4a124cedc49b Mon Sep 17 00:00:00 2001 From: Viktor Rehnberg <35767167+VRehnberg@users.noreply.github.com> Date: Wed, 28 Aug 2024 11:16:35 +0200 Subject: [PATCH 1/4] Update of Github CI template The template provided by Github has changed slighlty as such this file should look a bit different as well. --- content/continuous-integration.md | 93 ++++++++++++++++--------------- 1 file changed, 47 insertions(+), 46 deletions(-) diff --git a/content/continuous-integration.md b/content/continuous-integration.md index 74e9680..13c374e 100644 --- a/content/continuous-integration.md +++ b/content/continuous-integration.md @@ -240,53 +240,54 @@ in the [Collaborative Git lesson](https://coderefinery.github.io/git-collaborati ```{code-block} yaml --- - emphasize-lines: 16,29,39-45 + emphasize-lines: 14,30,40-46 --- - # This workflow will install Python dependencies, run tests and lint with a variety of Python versions - # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python - - name: Python package - - on: - push: - branches: [ "main" ] - pull_request: - branches: [ "main" ] - - jobs: - build: - permissions: - contents: read - pull-requests: write - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3 - - name: Set up Python 3.10 - uses: actions/setup-python@v3 - with: - python-version: "3.10" - - name: Install dependencies - run: | - python -m pip install --upgrade pip - python -m pip install flake8 pytest pytest-cov - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - - name: Lint with flake8 - run: | - # stop the build if there are Python syntax errors or undefined names - flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics - # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide - flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics - - name: Test with pytest and calculate coverage - run: | - pytest --cov-report "xml:coverage.xml" --cov=. - - name: Create Coverage - if: ${{ github.event_name == 'pull_request' }} - uses: orgoro/coverage@v3 - with: - coverageFile: coverage.xml - token: ${{ secrets.GITHUB_TOKEN }} +# This workflow will install Python dependencies, run tests and lint with a single version of Python +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python + +name: Python application + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +permissions: + contents: read + pull-requests: write + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up Python 3.10 + uses: actions/setup-python@v3 + with: + python-version: "3.10" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install flake8 pytest pytest-cov + if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + - name: Lint with flake8 + run: | + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Test with pytest + run: | + pytest --cov-report "xml:coverage.xml" --cov=. + - name: Create Coverage + if: ${{ github.event_name == 'pull_request' }} + uses: orgoro/coverage@v3 + with: + coverageFile: coverage.xml + token: ${{ secrets.GITHUB_TOKEN }} ``` Commit the change by pressing the "Start Commit" button: From 78352f7e8f2012a92a2efc3185dcc896104c2d9e Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Wed, 28 Aug 2024 17:43:05 +0200 Subject: [PATCH 2/4] fix indentation to make it easier to compare with before --- content/continuous-integration.md | 92 +++++++++++++++---------------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/content/continuous-integration.md b/content/continuous-integration.md index 13c374e..d26c475 100644 --- a/content/continuous-integration.md +++ b/content/continuous-integration.md @@ -242,52 +242,52 @@ in the [Collaborative Git lesson](https://coderefinery.github.io/git-collaborati --- emphasize-lines: 14,30,40-46 --- -# This workflow will install Python dependencies, run tests and lint with a single version of Python -# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python - -name: Python application - -on: - push: - branches: [ "main" ] - pull_request: - branches: [ "main" ] - -permissions: - contents: read - pull-requests: write - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - name: Set up Python 3.10 - uses: actions/setup-python@v3 - with: - python-version: "3.10" - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install flake8 pytest pytest-cov - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - - name: Lint with flake8 - run: | - # stop the build if there are Python syntax errors or undefined names - flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics - # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide - flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics - - name: Test with pytest - run: | - pytest --cov-report "xml:coverage.xml" --cov=. - - name: Create Coverage - if: ${{ github.event_name == 'pull_request' }} - uses: orgoro/coverage@v3 - with: - coverageFile: coverage.xml - token: ${{ secrets.GITHUB_TOKEN }} + # This workflow will install Python dependencies, run tests and lint with a single version of Python + # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python + + name: Python application + + on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + + permissions: + contents: read + pull-requests: write + + jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up Python 3.10 + uses: actions/setup-python@v3 + with: + python-version: "3.10" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install flake8 pytest pytest-cov + if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + - name: Lint with flake8 + run: | + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Test with pytest + run: | + pytest --cov-report "xml:coverage.xml" --cov=. + - name: Create Coverage + if: ${{ github.event_name == 'pull_request' }} + uses: orgoro/coverage@v3 + with: + coverageFile: coverage.xml + token: ${{ secrets.GITHUB_TOKEN }} ``` Commit the change by pressing the "Start Commit" button: From fa2f702512df05340d493b8c40fb8cce70546220 Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Wed, 28 Aug 2024 17:43:36 +0200 Subject: [PATCH 3/4] better workflow name --- content/continuous-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/continuous-integration.md b/content/continuous-integration.md index d26c475..01b1cad 100644 --- a/content/continuous-integration.md +++ b/content/continuous-integration.md @@ -245,7 +245,7 @@ in the [Collaborative Git lesson](https://coderefinery.github.io/git-collaborati # This workflow will install Python dependencies, run tests and lint with a single version of Python # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python - name: Python application + name: Test on: push: From 79188af25848daf6c5a281e274aeb8f9689aed67 Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Wed, 28 Aug 2024 17:43:42 +0200 Subject: [PATCH 4/4] sphinx does not build locally for me with v8.0 --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 541791b..9719324 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -Sphinx +sphinx < 8.0 sphinx_rtd_theme myst_nb git+https://github.com/rkdarst/sphinx-copybutton.git@exclude-unselectable-3