🎉🎊🍾 [New Feature + Breaking Change + Refactor] (config + docs) Add new feature, integrate organizing reports features and update document.

.coveragerc

@@ -1,11 +1,7 @@
-# # This test directory for testing to simulate a Python library project structure.
-
 [run]
+branch = True
 parallel = True
-relative_files = True
 source=./test_gh_workflow
 
 omit =
     */__init__.py
-
-#ignore_errors = True

.github/release-auto-flag.txt

@@ -0,0 +1 @@
+true

.github/release-notes.md

@@ -0,0 +1,17 @@
+### 🎉🎊🍾 New feature
+<hr>
+
+1. Add new options about set up and run a sample HTTP server for testing if it needs in some testing scenario (_run_test_items_via_pytest.yaml_).
+
+### 🛠⚙️🔩 **Breaking Change**
+<hr>
+
+1. Integrate the feature about organizing and generating testing coverage reports into a reusable workflow. So workflow could be shorter and clear (_organize_and_generate_test_cov_reports.yaml_).
+2. Integrate all the uploading test coverage report features into a reusable workflow (_upload_test_cov_report.yaml_).
+3. Update document README.
+4. Move the PR template to **_.github_** directory (for working finely).
+
+### ⚒⚒💣 **Bug Fix** 
+<hr>
+
+1. Fix the issue about uploading test coverage report cannot work at all.

.github/release-title.md

@@ -0,0 +1 @@
+v2.0.0 - More short and clear <0001f9f9>🍻

.github/workflows/build_git-tag_and_create_github-release.yaml

@@ -0,0 +1,100 @@
+##############################################################################################
+#
+# Workflow Description:
+#     Build a git tag on a specific commit in every git branch. And create GitHub release if current git branch is 'master'.
+#
+# Workflow input parameters:
+#     * General arguments:
+#         * project_type: Different project type would get the software version info in different way.
+#         * debug_mode: It would run the tasks as log message, doesn't essentially run feature if this option is true.
+#         * project_name: The project name.
+#         * software_version_format: The format of software version.
+#
+# Workflow running output:
+#     Yes, it has running result output. The output is the release version.
+#
+#     * Workflow output:
+#          It would output the version which would be build as git tag and create GitHub release version title.
+#         * python_release_version: Python project release version info.
+#         * github-action_reusable_workflow_release_version: GitHub Action reusable workflow project release version info.
+#
+##############################################################################################
+
+name: Build git tag and create GitHub release with software version
+
+on:
+  workflow_call:
+    inputs:
+      project_type:
+        description: "Different project type would get the software version info in different way."
+        required: true
+        type: string    # Option: python, github-action_reusable-workflow
+#      activate_git_event:
+#        description: "Which git event should activate the workflow."
+#        type: string
+#        required: false
+#        default: push
+      debug_mode:
+        description: "It would run the tasks as log message, doesn't essentially run feature if this option is true."
+        type: boolean
+        required: false
+        default: false
+      project_name:
+        description: "The project name."
+        type: string
+        required: false
+      software_version_format:
+        description: "The format of software version."
+        type: string
+        required: false
+
+    outputs:
+      python_release_version:
+        description: "The version which would be build as git tag and create GitHub release version title."
+        value: ${{ jobs.build_git-tag_and_create_github-release.outputs.matrix_python }}
+      github-action_reusable_workflow_release_version:
+        description: "The version which would be build as git tag and create GitHub release version title."
+        value: ${{ jobs.build_git-tag_and_create_github-release.outputs.matrix_github_action_reusable_workflow }}
+
+
+jobs:
+  build_git-tag_and_create_github-release:
+#    name: Build git tag and GitHub release if it needs
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+    outputs:
+      matrix_python: ${{ steps.python_release.outputs.release_type }}
+      matrix_github_action_reusable_workflow: ${{ steps.github_action_reusable_workflow_release.outputs.release_version }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Download shell script for checking input parameters
+        run: curl https://raw.githubusercontent.com/Chisanan232/GitHub-Action_Workflow-Template-Python/develop/scripts/ci/build_git-tag_or_create_github-release.sh --output ./scripts/ci/build_git-tag_or_create_github-release.sh
+
+      # This flow for the project type is Python project
+      - name: Build git tag and create GitHub release for Python project
+        if: ${{ inputs.project_type == 'python-package' }}
+        id: python_release
+        run: | 
+          release=$(bash ./scripts/ci/build_git-tag_or_create_github-release.sh ${{ inputs.project_type }}  ${{ inputs.debug_mode }} ${{ inputs.project_name }} ${{ inputs.software_version_format }})
+          echo "📄 Release log: $release"
+
+          release_type=$(echo "$release" | grep -E "\[Python\] \[Final Running Result\] ((Official\-Release)|(Pre\-Release))" | grep -E -o "((Official\-Release)|(Pre\-Release))")
+          echo "🐍 Release Type: $release_type"
+
+          echo "::set-output name=release_type::$(echo $release_type)"
+
+      # This flow for the project type is GitHub Action reusable workflow
+      - name: Build git tag and create GitHub release for GitHub Action reusable workflow project
+        if: ${{ inputs.project_type == 'github-action-reusable-workflow' }}
+        id: github_action_reusable_workflow_release
+        run: | 
+          release=$(bash ./scripts/ci/build_git-tag_or_create_github-release.sh ${{ inputs.project_type }} ${{ inputs.debug_mode }})
+          echo "📄 Release log: $release"
+
+          release_version=$(echo "$release" | grep -E "\[GitHub Action - Reusable workflow\] \[Final Running Result\] Official-Release and version: ([0-9]{1,})" | grep -E -o "([0-9]{1,})")
+          echo "🤖 Release Version: $release_version"
+
+          echo "::set-output name=release_version::$(echo $release_version)"
+

.github/workflows/ci-cd.yaml

@@ -0,0 +1,52 @@
+name: GitHub Action reusable workflow build
+
+on:
+  push:
+    branches:
+      - "develop"
+      - "release"
+      - "master"
+    paths-ignore:
+      - ".gitcommitrules"
+      - ".gitignore"
+      - "LICENSE"
+      - "README.md"
+
+  pull_request:
+    branches:
+      - "develop"
+      - "release"
+    paths-ignore:
+      - ".gitcommitrules"
+      - ".gitignore"
+      - "LICENSE"
+      - "README.md"
+
+jobs:
+  test_build_git-tag_and_create_github-release:
+#    name: Build git tag and GitHub release if it needs
+    uses: ./.github/workflows/build_git-tag_and_create_github-release.yaml
+    with:
+      project_type: github-action-reusable-workflow
+      debug_mode: false
+
+
+  test_deploy_as_new_branch:
+#    name: Create new git branch by the tagged commit
+    needs: test_build_git-tag_and_create_github-release
+    if: ${{ github.ref_name == 'master' && 
+                github.event_name == 'push' && 
+                needs.test_build_git-tag_and_create_github-release.outputs.github-action_reusable_workflow_release_version != 'Pre' }}
+    runs-on: ubuntu-latest
+    env:
+      RELEASE_TYPE: ${{ needs.test_build_git-tag_and_create_github-release.outputs.github-action_reusable_workflow_release_version }}
+      DEBUG_MODE: false
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Check it whether get the output of previous one job which has version info or not
+        run: bash scripts/ci/check_getting_output.sh
+
+      - name: Create new git branch by the tagged commit
+        run: bash ./scripts/ci/deployment_new_version_workflow.sh $DEBUG_MODE
+

.github/workflows/organize_and_generate_testing_coverage_reports.yaml → .github/workflows/organize_and_generate_test_cov_reports.yaml

@@ -1,4 +1,4 @@
-############################################################################
+###################################################################################################################################
 #
 # Workflow Description:
 #     Organize all the testing coverage reports. (it would save reports by 'actions/upload-artifact@v3').
@@ -9,7 +9,11 @@
 # Workflow running output:
 #     No, but it would save the testing coverage reports (coverage.xml) to provide after-process to organize and record.
 #
-############################################################################
+#     * Upload-Artifact:
+#         * test_coverage_report: The handled test coverage report (.coverage file). It's file name format would be .coverage.<inputs.test type>.
+#         * test_coverage_xml_report: The handled test coverage report (.xml file). It's file name format would be coverage_<inputs.test type>.xml.
+#
+###################################################################################################################################
 
 name: Organize all testing coverage reports which be tested in many different runtime OS and Python version as a testing coverage report
 
@@ -45,6 +49,8 @@ jobs:
           python3 -m pip install --upgrade pip
           pip3 install -U pip
           pip3 install coverage
+          pip3 install codecov
+          pip3 install coveralls
 
       - name: Combine all testing code coverage result files with one specific test type
         if: ${{ inputs.test_type == 'unit-test' || inputs.test_type == 'integration-test' }}
@@ -60,9 +66,16 @@ jobs:
       - name: General testing coverage report as XML format with ${{ inputs.test_type }}
         run: coverage xml --data-file=.coverage.${{ inputs.test_type }} -o coverage_${{ inputs.test_type }}.xml
 
-      - name: Upload testing coverage report
+      - name: Upload testing coverage report (.coverage)
+        uses: actions/upload-artifact@v3
+        with:
+          name: test_coverage_report
+          path: .coverage.${{ inputs.test_type }}
+          if-no-files-found: error
+
+      - name: Upload testing coverage report (.xml)
         uses: actions/upload-artifact@v3
         with:
-          name: final_project_testing_coverage_report
+          name: test_coverage_xml_report
           path: coverage_${{ inputs.test_type }}.xml
           if-no-files-found: error

.github/workflows/run_test_items_via_pytest.yaml

@@ -1,4 +1,4 @@
-############################################################################
+#################################################################################################################################
 #
 # Workflow Description:
 #     Run testing by specific type with all test items via PyTest and generate its testing
@@ -12,11 +12,16 @@
 #     * http_server_port: The port number of HTTP server.
 #     * http_server_app_module: The module path of HTTP server.
 #     * http_server_enter_point: The object about the web application.
+#     * debug_mode: For debug, so it's matrix would one has os: ubuntu-22.04 & python-version: '3.10'.
 #
 # Workflow running output:
 #     No, but it would save the testing coverage reports to provide after-process to organize and record.
 #
-############################################################################
+#     * Upload-Artifact:
+#         * coverage: The test coverage report which be generated by PyTest, and it's recorded after run test done.
+#                           The file name format would be .coverage.<test type>.<runtime os>-<python-version>
+#
+#################################################################################################################################
 
 name: Run test items via PyTest
 
@@ -56,16 +61,22 @@ on:
         type: string
         required: false
         default: app
+      debug_mode:
+        description: "For debug, so it's matrix would one has os: ubuntu-22.04 & python-version: '3.10'."
+        type: boolean
+        required: false
+        default: false
 
 
 jobs:
   run_test_items:
+    if: ${{ inputs.debug_mode == false }}
     runs-on: ${{ matrix.os }}
 
     strategy:
       matrix:
         python-version: [3.6,3.7,3.8,3.9,'3.10']
-        os: [ubuntu-18.04,ubuntu-20.04,ubuntu-22.04, macos-10.15,macos-11,macos-12]
+        os: [ubuntu-18.04,ubuntu-20.04,ubuntu-22.04,macos-10.15,macos-11,macos-12]
         exclude:
           - os: ubuntu-18.04
             python-version: 3.6
@@ -128,3 +139,50 @@ jobs:
           path: .coverage.${{ inputs.test_type }}.${{ matrix.os }}-${{ matrix.python-version }}
           if-no-files-found: error
 
+
+  run_test_items_with_debug_mode:
+    if: ${{ inputs.debug_mode == true }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        python-version: ['3.10']
+        os: [ubuntu-22.04]
+        test-path: ${{fromJson(inputs.all_test_items_paths)}}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -U pip
+          pip install -U -r ./requirements/requirements.txt
+          pip install -U -r ./requirements/requirements-test.txt
+
+      - name: Setup and run HTTP server for testing
+        if: ${{ inputs.setup_http_server == true }}
+        run: gunicorn --bind ${{ inputs.http_server_host }}:${{ inputs.http_server_port }} '${{ inputs.http_server_app_module }}:${{ inputs.http_server_enter_point }}' --daemon
+
+      - name: Test to send HTTP request to sample HTTP server
+        if: ${{ inputs.setup_http_server == true }}
+        run: curl "http://${{ inputs.http_server_host }}:${{ inputs.http_server_port }}/exchangeReport/STOCK_DAY?response=json&date=20170101&stockNo=2331"
+
+      - name: Run tests with pytest
+        run: pytest ${{ matrix.test-path }}
+        continue-on-error: true
+
+      - name: Rename the code coverage result file
+        run: mv ./.coverage ./.coverage.${{ inputs.test_type }}.${{ matrix.os }}-${{ matrix.python-version }}
+
+      - name: Upload code coverage result file
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage
+          path: .coverage.${{ inputs.test_type }}.${{ matrix.os }}-${{ matrix.python-version }}
+          if-no-files-found: error

.github/workflows/test_gh_reusable_workflow.yaml

@@ -0,0 +1,56 @@
+name: GitHub Action reusable workflow project CI Test
+
+on:
+  push:
+    branches:
+      - "develop"
+      - "release"
+      - "release-**"
+      - "release/**"
+      - "master"
+    paths-ignore:
+      - ".gitcommitrules"
+      - ".gitignore"
+      - "LICENSE"
+      - "README.md"
+
+  pull_request:
+    branches:
+      - "develop"
+      - "release"
+      - "release-**"
+      - "release/**"
+      - "master"
+    paths-ignore:
+      - ".gitcommitrules"
+      - ".gitignore"
+      - "LICENSE"
+      - "README.md"
+
+jobs:
+  test_build_git-tag_and_create_github-release:
+#    name: Build git tag and GitHub release if it needs
+    uses: ./.github/workflows/build_git-tag_and_create_github-release.yaml
+    with:
+      project_type: github-action-reusable-workflow
+      debug_mode: true
+
+
+  test_deploy_as_new_branch:
+#    name: Create new git branch by the tagged commit
+    needs: test_build_git-tag_and_create_github-release
+    if: ${{ github.event_name == 'push' && 
+                needs.test_build_git-tag_and_create_github-release.outputs.github-action_reusable_workflow_release_version != 'Initial' && 
+                needs.test_build_git-tag_and_create_github-release.outputs.github-action_reusable_workflow_release_version != 'Pre' }}
+    runs-on: ubuntu-latest
+    env:
+      RELEASE_TYPE: ${{ needs.test_build_git-tag_and_create_github-release.outputs.github-action_reusable_workflow_release_version }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Check it whether get the output of previous one job which has version info or not
+        run: bash scripts/ci/check_getting_output.sh
+
+      - name: Create new git branch by the tagged commit
+        run: bash ./scripts/ci/deployment_new_version_workflow.sh 'true'
+