fomat doc

Author: SKairinos

.github/workflows/python-package.yml

@@ -5,10 +5,10 @@ name: Python package
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
     paths-ignore:
-    - "codeforlife/version.py"
-    - "CHANGELOG.md"
+      - "codeforlife/version.py"
+      - "CHANGELOG.md"
 
 jobs:
   test:
@@ -19,65 +19,65 @@ jobs:
       matrix:
         python-version: ["3.7"]
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Python Packages
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install pipenv
+          pipenv install --dev
+
+      - name: Check Code Format
+        run: if ! pipenv run black --check .; then exit 1; fi
+
+      # TODO: assert code coverage target.
+      - name: Test Code Units
+        run: pipenv run pytest tests
 
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-    
-    - name: Install Python Packages
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install pipenv
-        pipenv install --dev
-    
-    - name: Check Code Format
-      run: if ! pipenv run black --check .; then exit 1; fi
-    
-    # TODO: assert code coverage target.
-    - name: Test Code Units
-      run: pipenv run pytest tests
-  
   release:
     name: Publish Release
     concurrency: release
     runs-on: ubuntu-latest
     needs: [test]
     steps:
-    - uses: actions/checkout@v3
-      with:
-        token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
-        fetch-depth: 0
-    
-    - name: Set up Python 3.7
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.7'
-    
-    - name: Install Dependencies
-      run: |
-        python -m pip install --upgrade pip
-        # pipenv-setup requires downgraded vistir: https://github.com/Madoshakalaka/pipenv-setup/issues/138
-        python -m pip install python-semantic-release~=7.33 pipenv-setup[black]==3.2.0 vistir==0.6.1
-      
-    - name: Setup Git
-      run: |
-        git config --local user.name github-actions
-        git config --local user.email [email protected]
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          fetch-depth: 0
+
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.7"
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          # pipenv-setup requires downgraded vistir: https://github.com/Madoshakalaka/pipenv-setup/issues/138
+          python -m pip install python-semantic-release~=7.33 pipenv-setup[black]==3.2.0 vistir==0.6.1
+
+      - name: Setup Git
+        run: |
+          git config --local user.name github-actions
+          git config --local user.email [email protected]
+
+      - name: Sync Setup Dependencies
+        run: |
+          pipenv-setup sync
+          git add setup.py
 
-    - name: Sync Setup Dependencies
-      run: |
-        pipenv-setup sync
-        git add setup.py
+          # Only commit and push if there are differences.
+          if ! git diff --staged --quiet; then
+            git commit -m "ci[setup]: sync dependencies [skip ci]"
+            git push
+          fi
 
-        # Only commit and push if there are differences.
-        if ! git diff --staged --quiet; then
-          git commit -m "ci[setup]: sync dependencies [skip ci]"
-          git push
-        fi
-    
-    - name: Publish Semantic Release
-      env:
-        GH_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
-      run: semantic-release publish --verbosity=INFO
+      - name: Publish Semantic Release
+        env:
+          GH_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+        run: semantic-release publish --verbosity=INFO