Harmonize CI workflow headings

IAMconsortium · Mar 6, 2024 · af878f5 · af878f5
1 parent 22ab7b5
commit af878f5
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 45 deletions.
diff --git 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
@@ -37,42 +37,42 @@ 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
 
-    #----------------------------------------------
-    # 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
       with:
         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
@@ -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
@@ -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,23 +45,26 @@ jobs:
         poetry add [email protected] --lock
         poetry add [email protected] --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
       with:
         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
@@ -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