Add default and advanced prechecks workflows for Unix (#203)

* Change trigger for unix/windows workflows

* Add advanced prechecks for unix

* Add default prechecks for unix

* Add docs

* Change code segment meta

Author: pranavmalaviya

.github/workflows/prechecks-unix.yml .github/workflows/advanced-prechecks-unix.yml

@@ -1,17 +1,18 @@
-name: "Prechecks Unix"
+name: "Advanced Prechecks Unix"
 
 on:
   pull_request:
     branches: [ master ]
+    types: [ labeled ]
     paths-ignore:
       - "*.md"
-      - "windows/**"
-      - "libvirt/**"
+      - "!unix/**"
       - "unix/prechecks/**"
 
 jobs:
   ubuntu:
     runs-on: ubuntu-latest
+    if: ${{ github.event.label.name == 'ci' }}
     strategy:
       matrix:
         python-version: [ '3.7', '3.8', '3.9', '3.10' ]
@@ -27,14 +28,6 @@ jobs:
       - name: Install pipenv
         run: python -m pip install --upgrade pipenv wheel
 
-      - name: Install flake8
-        run: pip install flake8
-
-      ## Check linting ##
-      - name: Run flake8 linter
-        working-directory: unix
-        run: flake8 ./src --config ./setup.cfg
-
       ## Check packaging ##
       - name: Install dependencies
         working-directory: unix
@@ -46,6 +39,7 @@ jobs:
 
   rhel:
     runs-on: ubuntu-latest
+    if: ${{ github.event.label.name == 'ci' }}
     strategy:
       matrix:
         python-version: [ '3.6', '3.8', '3.9', '3.10' ]

.github/workflows/default-prechecks-unix.yml

@@ -0,0 +1,32 @@
+name: "Default Prechecks Unix"
+
+on:
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - "*.md"
+      - "!unix/**"
+      - "unix/prechecks/**"
+
+jobs:
+  ubuntu:
+    runs-on: ubuntu-latest
+    name: Ubuntu Default Prechecks
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v3
+        with:
+          python-version: 3.8
+          architecture: x64
+
+      - name: Install pipenv
+        run: python -m pip install --upgrade pipenv wheel
+
+      - name: Install flake8
+        run: pip install flake8
+
+      ## Check linting ##
+      - name: Run flake8 linter
+        working-directory: unix
+        run: flake8 ./src --config ./setup.cfg

.github/workflows/prechecks-windows.yml

@@ -5,8 +5,7 @@ on:
     branches: [ master ]
     paths-ignore:
       - "*.md"
-      - "unix/**"
-      - "libvirt/**"
+      - "!windows/**"
 
 jobs:
   windows:

unix/CONTRIBUTING.md

@@ -14,7 +14,7 @@ it's 3.9.  You can use any operating system.
 Install all development dependencies using:
 
 ```console
-$ pipenv install --dev
+pipenv install --dev
 ```
 
 If you haven't used `pipenv` before but are comfortable with virtualenvs, just
@@ -28,9 +28,9 @@ run `pipenv run machine_stats` to run it locally.
 Non `pipenv` install works too:
 
 ```console
-$ pip install -r requirements.txt
-$ pip install -r dev-requirements.txt
-$ pip install -e .
+pip install -r requirements.txt
+pip install -r dev-requirements.txt
+pip install -e .
 ```
 
 ### Tools
@@ -55,14 +55,22 @@ For example, if the current version in `1.0.0`:
 
 After that all you need to do is to run
 
-```
+```console
 git push origin master
 git push origin --tags
 ```
 
 This will update the version and trigger the PyPI build and deploy.
 
 _Note_: You can verify that the version has been updated after running the `bump2version` command by checking the `config.cfg` file. (current_version)
+
+### Introducing breaking changes?
+
+When you create a PR, the GitHub workflows check for the linting and CodeQL. However, if you think you're introducing breaking changes, then please add the label `ci` with your PR. This will run the Advanced Prechecks workflow that checks Machine Stats' working in the following system environments:
+
+* Ubuntu 20.04 - Python 3.7 to 3.10
+* RHEL 8 - Python 3.6, 3.8 to 3.10
+
 ## Finally
 
 Thanks again for your interest in improving the project! You're taking action