From af878f5046ab7807afadb75eaa10b3137057a4eb Mon Sep 17 00:00:00 2001 From: Fridolin Glatter Date: Wed, 6 Mar 2024 14:43:04 +0100 Subject: [PATCH] Harmonize CI workflow headings --- .github/workflows/build-docs.yml | 20 ++++++++++--------- .github/workflows/nightly.yml | 30 ++++++++++++++--------------- .github/workflows/publish.yml | 6 +++--- .github/workflows/pytest-legacy.yml | 21 +++++++++++--------- .github/workflows/pytest.yml | 19 +++++++++--------- 5 files changed, 51 insertions(+), 45 deletions(-) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 8ff597605..79af12c1e 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -24,27 +24,29 @@ jobs: - name: Install Pandoc uses: r-lib/actions/setup-pandoc@v2 - #---------------------------------------------- - # ----- install & configure poetry ----- - #---------------------------------------------- + #------------------------------ + # install & configure poetry + #------------------------------ - name: Install Poetry uses: snok/install-poetry@v1 with: virtualenvs-create: true virtualenvs-in-project: true installer-parallel: true - #---------------------------------------------- - # load cached venv if cache exists - #---------------------------------------------- + + #------------------------------------ + # load cached venv if cache exists + #------------------------------------ - name: Load cached venv id: cached-poetry-dependencies uses: actions/cache@v4 with: path: .venv key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }} - #---------------------------------------------- - # install your root project, if required - #---------------------------------------------- + + #------------------------ + # install root project + #------------------------ - name: Install library run: poetry install --no-interaction --with docs,optional_plotting,tutorials diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 9bb4c0752..8c165a152 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -37,9 +37,9 @@ jobs: - name: Install Pandoc uses: r-lib/actions/setup-pandoc@v2 - #---------------------------------------------- - # ----- install & configure poetry ----- - #---------------------------------------------- + #------------------------------ + # install & configure poetry + #------------------------------ - name: Install Poetry uses: snok/install-poetry@v1 with: @@ -47,15 +47,15 @@ jobs: virtualenvs-in-project: true installer-parallel: true - #---------------------------------------------- - # Update dependencies to latest versions - #---------------------------------------------- + #------------------------------------------ + # update dependencies to latest versions + #------------------------------------------ - name: Update dependencies run: poetry update --with docs,optional_io_formats,optional_plotting,tests,tutorials --lock - #---------------------------------------------- - # load cached venv if cache exists - #---------------------------------------------- + #------------------------------------ + # load cached venv if cache exists + #------------------------------------ - name: Load cached venv id: cached-poetry-dependencies uses: actions/cache@v4 @@ -63,16 +63,16 @@ jobs: path: .venv key: venv-${{ matrix.os }}-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }} - #----------------------------------------------- - # install dependencies if cache does not exist - #----------------------------------------------- + #------------------------------------------------ + # install dependencies if cache does not exist + #------------------------------------------------ - name: Install dependencies if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' run: poetry install --no-interaction --with docs,optional_io_formats,optional_plotting,tests,tutorials --no-root - #---------------------------------------------- - # install your root project, if required - #---------------------------------------------- + #------------------------ + # install root project + #------------------------ - name: Install library run: poetry install --no-interaction --only-root diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 4f04683dd..efce8d801 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -19,9 +19,9 @@ jobs: - uses: actions/setup-python@v5 - #---------------------------------------------- - # ----- install & configure poetry ----- - #---------------------------------------------- + #------------------------------ + # install & configure poetry + #------------------------------ - name: Install Poetry uses: snok/install-poetry@v1 with: diff --git a/.github/workflows/pytest-legacy.yml b/.github/workflows/pytest-legacy.yml index 662e0d0e7..43e9b5237 100644 --- a/.github/workflows/pytest-legacy.yml +++ b/.github/workflows/pytest-legacy.yml @@ -23,9 +23,9 @@ jobs: with: python-version: '3.10' - #---------------------------------------------- - # ----- install & configure poetry ----- - #---------------------------------------------- + #------------------------------ + # install & configure poetry + #------------------------------ - name: Install Poetry uses: snok/install-poetry@v1 with: @@ -45,9 +45,9 @@ jobs: poetry add pint@0.13 --lock poetry add xlrd@2.0.1 --group optional_io_formats --lock - #---------------------------------------------- - # load cached venv if cache exists - #---------------------------------------------- + #------------------------------------ + # load cached venv if cache exists + #------------------------------------ - name: Load cached venv id: cached-poetry-dependencies uses: actions/cache@v4 @@ -55,13 +55,16 @@ jobs: path: .venv key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }} - #----------------------------------------------- - # install dependencies if cache does not exist - #----------------------------------------------- + #------------------------------------------------ + # install dependencies if cache does not exist + #------------------------------------------------ - name: Install dependencies if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' run: poetry install --no-interaction --with optional_io_formats,optional_plotting,tests,tutorials --no-root + #------------------------ + # install root project + #------------------------ - name: Install library run: poetry install --no-interaction diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml index eccbd6054..3b985e089 100644 --- a/.github/workflows/pytest.yml +++ b/.github/workflows/pytest.yml @@ -40,27 +40,28 @@ jobs: with: python-version: ${{ matrix.python-version }} - #---------------------------------------------- - # ----- install & configure poetry ----- - #---------------------------------------------- + #------------------------------ + # install & configure poetry + #------------------------------ - name: Install Poetry uses: snok/install-poetry@v1 with: virtualenvs-create: true virtualenvs-in-project: true installer-parallel: true - #---------------------------------------------- - # load cached venv if cache exists - #---------------------------------------------- + + #------------------------------------ + # load cached venv if cache exists + #------------------------------------ - name: Load cached venv id: cached-poetry-dependencies uses: actions/cache@v4 with: path: .venv key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }} - #---------------------------------------------- - # install your root project, if required - #---------------------------------------------- + #------------------------ + # install your project + #------------------------ - name: Install library run: poetry install --no-interaction --with optional_io_formats,optional_plotting,tests,tutorials