Merge pull request #70 from qua-platform/add_ci_workflows_description

CI: add workflows description

.github/workflows/build.yaml

@@ -1,3 +1,10 @@
+# This workflow is used for manual (can be triggered via GitHub web interface)
+# build of package archives for distribution. The build workflow 
+# (.github/workflows/reusable-build.yaml) is triggered for creation wheel and 
+# sdist package archives. 
+
+name: Build python package manually (with built frontend)
+
 on:
   workflow_dispatch
 

.github/workflows/ci.yaml

@@ -1,4 +1,11 @@
+# This workflow is used for automatically running checks on adding commit to 
+# pull requests. There are 2 global types of check: frontend and backend.
+# Frontend checks include eslint and stylelint checks. Backend checks triggers 
+# poe (poethepoet) commands: type, lint, format. The commands are defined in 
+# pyproject.toml. Also, backend checks include tests run.
+
 name: Format; lint; type; tests
+
 on:
   pull_request
 

.github/workflows/release.yaml

@@ -1,4 +1,9 @@
-name: Create release
+# This workflow is used for creating draft release on GitHub. Firstly the 
+# build workflow (.github/workflows/reusable-build.yaml) is triggered for 
+# creation wheel and sdist package archives. Then the draft GitHub release is 
+# created with attached built python package archives.
+
+name: Create draft GitHub release
 
 on:
   push:

.github/workflows/reusable-buld.yaml → .github/workflows/reusable-build.yaml

@@ -1,4 +1,13 @@
-name: Build python package with built frontend
+# This workflow is used for building qualibrate-app python package in dist 
+# and wheel formats. It should be noted that firstly the frontend package is 
+# built. And build frontend files are added to the backend package. Then the
+# backand package is built. Built backend package archives is attached to 
+# workflow run as artifacts. The workflow should only be automatically 
+# triggered by other workflows (manual build and release).
+
+name:
+  Reusable build python package with built frontend (called by other workflows)
+
 on:
   workflow_call
 jobs: