diff --git a/.github/workflows/ci-cd.yaml b/.github/workflows/ci-cd.yaml index 37b92682..3299d141 100644 --- a/.github/workflows/ci-cd.yaml +++ b/.github/workflows/ci-cd.yaml @@ -23,10 +23,10 @@ on: - "README.md" jobs: - test_build_git-tag_and_create_github-release: + build_git-tag_and_create_github-release: # name: Build git tag and GitHub release if it needs if: ${{ github.ref_name == 'master' && github.event_name == 'push' }} - uses: ./.github/workflows/build_git-tag_and_create_github-release.yaml + uses: ./.github/workflows/rw_build_git-tag_and_create_github-release.yaml secrets: github_auth_token: ${{ secrets.GITHUB_TOKEN }} with: @@ -34,9 +34,9 @@ jobs: debug_mode: false - test_deploy_as_new_branch: + deploy_as_new_branch: # name: Create new git branch by the tagged commit - needs: test_build_git-tag_and_create_github-release + needs: 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-Release' }} diff --git a/.github/workflows/build_git-tag_and_create_github-release.yaml b/.github/workflows/rw_build_git-tag_and_create_github-release.yaml similarity index 100% rename from .github/workflows/build_git-tag_and_create_github-release.yaml rename to .github/workflows/rw_build_git-tag_and_create_github-release.yaml diff --git a/.github/workflows/prepare_test_items.yaml b/.github/workflows/rw_get_tests.yaml similarity index 100% rename from .github/workflows/prepare_test_items.yaml rename to .github/workflows/rw_get_tests.yaml diff --git a/.github/workflows/organize_and_generate_test_cov_reports.yaml b/.github/workflows/rw_organize_test_cov_reports.yaml similarity index 100% rename from .github/workflows/organize_and_generate_test_cov_reports.yaml rename to .github/workflows/rw_organize_test_cov_reports.yaml diff --git a/.github/workflows/poetry_run_test_via_pytest.yaml b/.github/workflows/rw_poetry_run_test.yaml similarity index 100% rename from .github/workflows/poetry_run_test_via_pytest.yaml rename to .github/workflows/rw_poetry_run_test.yaml diff --git a/.github/workflows/pre-building_test.yaml b/.github/workflows/rw_pre-building_test.yaml similarity index 100% rename from .github/workflows/pre-building_test.yaml rename to .github/workflows/rw_pre-building_test.yaml diff --git a/.github/workflows/push_pkg_to_pypi.yaml b/.github/workflows/rw_push_pypi.yaml similarity index 100% rename from .github/workflows/push_pkg_to_pypi.yaml rename to .github/workflows/rw_push_pypi.yaml diff --git a/.github/workflows/run_test_items_via_pytest.yaml b/.github/workflows/rw_run_test.yaml similarity index 100% rename from .github/workflows/run_test_items_via_pytest.yaml rename to .github/workflows/rw_run_test.yaml diff --git a/.github/workflows/sonarqube_scan.yaml b/.github/workflows/rw_sonarqube_scan.yaml similarity index 100% rename from .github/workflows/sonarqube_scan.yaml rename to .github/workflows/rw_sonarqube_scan.yaml diff --git a/.github/workflows/upload_test_cov_report.yaml b/.github/workflows/rw_upload_test_cov_report.yaml similarity index 100% rename from .github/workflows/upload_test_cov_report.yaml rename to .github/workflows/rw_upload_test_cov_report.yaml diff --git a/.github/workflows/test_gh_reusable_workflow.yaml b/.github/workflows/test_gh_reusable_workflow.yaml index 6cf75b50..aad9147e 100644 --- a/.github/workflows/test_gh_reusable_workflow.yaml +++ b/.github/workflows/test_gh_reusable_workflow.yaml @@ -30,7 +30,7 @@ on: 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 + uses: ./.github/workflows/rw_build_git-tag_and_create_github-release.yaml secrets: github_auth_token: ${{ secrets.GITHUB_TOKEN }} with: diff --git a/.github/workflows/test_pyproject_ci_multi-tests_by_poetry.yaml b/.github/workflows/test_pyproject_ci_multi-tests_by_poetry.yaml index ff955710..ca973112 100644 --- a/.github/workflows/test_pyproject_ci_multi-tests_by_poetry.yaml +++ b/.github/workflows/test_pyproject_ci_multi-tests_by_poetry.yaml @@ -30,14 +30,14 @@ on: jobs: prep-testbed_unit-test: # name: Prepare all unit test items - uses: ./.github/workflows/prepare_test_items.yaml + uses: ./.github/workflows/rw_get_tests.yaml with: shell_arg: test/unit_test/ prep-testbed_integration-test: # name: Prepare all integration test items - uses: ./.github/workflows/prepare_test_items.yaml + uses: ./.github/workflows/rw_get_tests.yaml with: shell_path: scripts/ci/test/get-integration-test-paths.sh shell_arg: unix @@ -47,7 +47,7 @@ jobs: run_unit-test: # name: Run all unit test items needs: prep-testbed_unit-test - uses: ./.github/workflows/poetry_run_test_via_pytest.yaml + uses: ./.github/workflows/rw_poetry_run_test.yaml with: test_type: unit-test all_test_items_paths: ${{needs.prep-testbed_unit-test.outputs.all_test_items}} @@ -56,7 +56,7 @@ jobs: run_integration-test: # name: Run all integration test items. This testing would test the code with other resource or system to ensure the features work finely. needs: prep-testbed_integration-test - uses: ./.github/workflows/poetry_run_test_via_pytest.yaml + uses: ./.github/workflows/rw_poetry_run_test.yaml with: test_type: integration-test all_test_items_paths: ${{needs.prep-testbed_integration-test.outputs.all_test_items}} @@ -70,7 +70,7 @@ jobs: all-test_codecov: # name: Organize and generate the testing report and upload it to Codecov needs: [run_unit-test, run_integration-test] - uses: ./.github/workflows/organize_and_generate_test_cov_reports.yaml + uses: ./.github/workflows/rw_organize_test_cov_reports.yaml with: test_type: all-test @@ -79,7 +79,7 @@ jobs: # name: Organize and generate the testing report and upload it to Codecov # if: github.ref_name == 'release' || github.ref_name == 'master' needs: [all-test_codecov] - uses: ./.github/workflows/upload_test_cov_report.yaml + uses: ./.github/workflows/rw_upload_test_cov_report.yaml secrets: codecov_token: ${{ secrets.CODECOV_TOKEN }} with: @@ -93,7 +93,7 @@ jobs: # name: Organize and generate the testing report and upload it to Coveralls # if: github.ref_name == 'release' || github.ref_name == 'master' needs: [all-test_codecov] - uses: ./.github/workflows/upload_test_cov_report.yaml + uses: ./.github/workflows/rw_upload_test_cov_report.yaml secrets: coveralls_token: ${{ secrets.COVERALLS_TOKEN }} with: @@ -104,7 +104,7 @@ jobs: codacy_finish: # name: Upload test report to Codacy to analyse and record code quality needs: [all-test_codecov] - uses: ./.github/workflows/upload_test_cov_report.yaml + uses: ./.github/workflows/rw_upload_test_cov_report.yaml secrets: codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }} with: @@ -115,7 +115,7 @@ jobs: sonarqube_finish: # name: Trigger SoarQube service to scan and analyse project needs: [all-test_codecov] - uses: ./.github/workflows/sonarqube_scan.yaml + uses: ./.github/workflows/rw_sonarqube_scan.yaml secrets: sonar_token: ${{ secrets.SONAR_TOKEN }} # with: @@ -127,7 +127,7 @@ jobs: # if: github.event_name == 'push' && (github.ref_name == 'release' || github.ref_name == 'master') if: github.event_name == 'push' needs: [codecov_finish, coveralls_finish, codacy_finish] - uses: ./.github/workflows/pre-building_test.yaml + uses: ./.github/workflows/rw_pre-building_test.yaml with: build-type: poetry python_package_name: Test-GitHub-Action-workflow @@ -138,7 +138,7 @@ jobs: build_git-tag_and_create_github-release: # name: Build git tag and GitHub release if it needs needs: pre-building_test - uses: ./.github/workflows/build_git-tag_and_create_github-release.yaml + uses: ./.github/workflows/rw_build_git-tag_and_create_github-release.yaml with: project_type: python-package project_name: test_gh_workflow diff --git a/.github/workflows/test_python_project_ci_multi-tests.yaml b/.github/workflows/test_python_project_ci_multi-tests.yaml index f79cec95..f5efbecc 100644 --- a/.github/workflows/test_python_project_ci_multi-tests.yaml +++ b/.github/workflows/test_python_project_ci_multi-tests.yaml @@ -32,14 +32,14 @@ on: jobs: prep-testbed_unit-test: # name: Prepare all unit test items - uses: ./.github/workflows/prepare_test_items.yaml + uses: ./.github/workflows/rw_get_tests.yaml with: shell_arg: test/unit_test/ prep-testbed_integration-test: # name: Prepare all integration test items - uses: ./.github/workflows/prepare_test_items.yaml + uses: ./.github/workflows/rw_get_tests.yaml with: shell_path: scripts/ci/test/get-integration-test-paths.sh shell_arg: unix @@ -49,7 +49,7 @@ jobs: run_unit-test: # name: Run all unit test items needs: prep-testbed_unit-test - uses: ./.github/workflows/run_test_items_via_pytest.yaml + uses: ./.github/workflows/rw_run_test.yaml with: test_type: unit-test all_test_items_paths: ${{needs.prep-testbed_unit-test.outputs.all_test_items}} @@ -59,7 +59,7 @@ jobs: run_integration-test: # name: Run all integration test items. This testing would test the code with other resource or system to ensure the features work finely. needs: prep-testbed_integration-test - uses: ./.github/workflows/run_test_items_via_pytest.yaml + uses: ./.github/workflows/rw_run_test.yaml with: test_type: integration-test all_test_items_paths: ${{needs.prep-testbed_integration-test.outputs.all_test_items}} @@ -74,7 +74,7 @@ jobs: all-test_codecov: # name: Organize and generate the testing report and upload it to Codecov needs: [run_unit-test, run_integration-test] - uses: ./.github/workflows/organize_and_generate_test_cov_reports.yaml + uses: ./.github/workflows/rw_organize_test_cov_reports.yaml with: test_type: all-test @@ -83,7 +83,7 @@ jobs: # name: Organize and generate the testing report and upload it to Codecov # if: github.ref_name == 'release' || github.ref_name == 'master' needs: [all-test_codecov] - uses: ./.github/workflows/upload_test_cov_report.yaml + uses: ./.github/workflows/rw_upload_test_cov_report.yaml secrets: codecov_token: ${{ secrets.CODECOV_TOKEN }} with: @@ -97,7 +97,7 @@ jobs: # name: Organize and generate the testing report and upload it to Coveralls # if: github.ref_name == 'release' || github.ref_name == 'master' needs: [all-test_codecov] - uses: ./.github/workflows/upload_test_cov_report.yaml + uses: ./.github/workflows/rw_upload_test_cov_report.yaml secrets: coveralls_token: ${{ secrets.COVERALLS_TOKEN }} with: @@ -108,7 +108,7 @@ jobs: codacy_finish: # name: Upload test report to Codacy to analyse and record code quality needs: [all-test_codecov] - uses: ./.github/workflows/upload_test_cov_report.yaml + uses: ./.github/workflows/rw_upload_test_cov_report.yaml secrets: codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }} with: @@ -116,11 +116,21 @@ jobs: upload-to-codacy: true + sonarqube_finish: +# name: Trigger SoarQube service to scan and analyse project + needs: [all-test_codecov] + uses: ./.github/workflows/rw_sonarqube_scan.yaml + secrets: + sonar_token: ${{ secrets.SONAR_TOKEN }} +# with: +# download_path: ${{ inputs.download_path }} + + pre-building_test: # name: Check about it could work finely by installing the Python package with setup.py file if: github.event_name == 'push' && (github.ref_name == 'release' || github.ref_name == 'master') - needs: [codecov_finish, coveralls_finish, codacy_finish] - uses: ./.github/workflows/pre-building_test.yaml + needs: [codecov_finish, coveralls_finish, codacy_finish, sonarqube_finish] + uses: ./.github/workflows/rw_pre-building_test.yaml with: python_package_name: Test-GitHub-Action-workflow test_shell_in_python: from test_gh_workflow import sample @@ -130,7 +140,7 @@ jobs: build_git-tag_and_create_github-release: # name: Build git tag and GitHub release if it needs needs: pre-building_test - uses: ./.github/workflows/build_git-tag_and_create_github-release.yaml + uses: ./.github/workflows/rw_build_git-tag_and_create_github-release.yaml with: project_type: python-package project_name: test_gh_workflow diff --git a/.github/workflows/test_python_project_ci_one-test.yaml b/.github/workflows/test_python_project_ci_one-test.yaml index 625f58fb..0b4907b7 100644 --- a/.github/workflows/test_python_project_ci_one-test.yaml +++ b/.github/workflows/test_python_project_ci_one-test.yaml @@ -31,7 +31,7 @@ on: jobs: prep-testbed_unit-test: # name: Prepare all unit test items - uses: ./.github/workflows/prepare_test_items.yaml + uses: ./.github/workflows/rw_get_tests.yaml with: shell_arg: test/unit_test/ @@ -39,7 +39,7 @@ jobs: run_unit-test: # name: Run all unit test items needs: prep-testbed_unit-test - uses: ./.github/workflows/run_test_items_via_pytest.yaml + uses: ./.github/workflows/rw_run_test.yaml with: test_type: unit-test all_test_items_paths: ${{needs.prep-testbed_unit-test.outputs.all_test_items}} @@ -49,7 +49,7 @@ jobs: unit-test_codecov: # name: Organize and generate the testing report and upload it to Codecov needs: run_unit-test - uses: ./.github/workflows/organize_and_generate_test_cov_reports.yaml + uses: ./.github/workflows/rw_organize_test_cov_reports.yaml with: test_type: unit-test @@ -58,7 +58,7 @@ jobs: # name: Organize and generate the testing report and upload it to Codecov # if: github.ref_name == 'release' || github.ref_name == 'master' needs: [unit-test_codecov] - uses: ./.github/workflows/upload_test_cov_report.yaml + uses: ./.github/workflows/rw_upload_test_cov_report.yaml secrets: codecov_token: ${{ secrets.CODECOV_TOKEN }} with: @@ -72,7 +72,7 @@ jobs: # name: Organize and generate the testing report and upload it to Coveralls # if: github.ref_name == 'release' || github.ref_name == 'master' needs: [unit-test_codecov] - uses: ./.github/workflows/upload_test_cov_report.yaml + uses: ./.github/workflows/rw_upload_test_cov_report.yaml secrets: coveralls_token: ${{ secrets.COVERALLS_TOKEN }} with: @@ -83,7 +83,7 @@ jobs: codacy_finish: # name: Upload test report to Codacy to analyse and record code quality needs: [unit-test_codecov] - uses: ./.github/workflows/upload_test_cov_report.yaml + uses: ./.github/workflows/rw_upload_test_cov_report.yaml secrets: codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }} with: @@ -94,7 +94,7 @@ jobs: sonarqube_finish: # name: Trigger SoarQube service to scan and analyse project needs: [unit-test_codecov] - uses: ./.github/workflows/sonarqube_scan.yaml + uses: ./.github/workflows/rw_sonarqube_scan.yaml secrets: sonar_token: ${{ secrets.SONAR_TOKEN }} # with: @@ -104,7 +104,7 @@ jobs: pre-building_test: # name: Check about it could work finely by installing the Python package with setup.py file needs: [codecov_finish, coveralls_finish, codacy_finish] - uses: ./.github/workflows/pre-building_test.yaml + uses: ./.github/workflows/rw_pre-building_test.yaml with: python_package_name: Test-GitHub-Action-workflow test_shell_in_python: from test_gh_workflow import sample @@ -114,7 +114,7 @@ jobs: build_git-tag_and_create_github-release: # name: Build git tag and GitHub release if it needs needs: pre-building_test - uses: ./.github/workflows/build_git-tag_and_create_github-release.yaml + uses: ./.github/workflows/rw_build_git-tag_and_create_github-release.yaml with: project_type: python-package project_name: test_gh_workflow @@ -126,7 +126,7 @@ jobs: # name: Upload the Python package files which has been compiled to PyPi if: github.event_name == 'push' && github.ref_name == 'release' needs: build_git-tag_and_create_github-release - uses: ./.github/workflows/push_pkg_to_pypi.yaml + uses: ./.github/workflows/rw_push_pypi.yaml with: release-type: ${{ needs.build_git-tag_and_create_github-release.outputs.python_release_version }} push-to-PyPI: test diff --git a/README.md b/README.md index c51caa97..76080abf 100644 --- a/README.md +++ b/README.md @@ -26,18 +26,18 @@ this project. This project has some workflow templates for reusing in GitHub Act The usage of each workflow template. -* [_prepare_test_items.yaml_](#prepare_test_itemsyaml) -* [_run_test_items_via_pytest.yaml_](#run_test_items_via_pytestyaml) -* [_organize_and_generate_test_cov_reports.yaml_](#organize_and_generate_test_cov_reportsyaml) -* [_upload_test_cov_report.yaml_](#upload_test_cov_reportyaml) -* [_pre-building_test.yaml_](#pre-building_testyaml) -* [_build_git-tag_and_create_github-release.yaml_](#build_git-tag_and_create_github-releaseyaml) -* [_push_pkg_to_pypi.yaml_](#push_pkg_to_pypiyaml) +* [_rw_get_tests.yaml_](#rw_get_testsyaml) +* [_rw_run_test.yaml_](#rw_run_testyaml) +* [_rw_organize_test_cov_reports.yaml_](#rw_organize_test_cov_reportsyaml) +* [_rw_upload_test_cov_report.yaml_](#rw_upload_test_cov_reportyaml) +* [_rw_pre-building_test.yaml_](#rw_pre-building_testyaml) +* [_rw_build_git-tag_and_create_github-release.yaml_](#rw_build_git-tag_and_create_github-releaseyaml) +* [_rw_push_pypi.yaml_](#rw_push_pypiyaml)
-### _prepare_test_items.yaml_ +### _rw_get_tests.yaml_ * Description: Prepare the test items. * Options: @@ -57,7 +57,7 @@ Before use this workflow, it should prepare a shell script for getting the testi ```yaml prepare-testing-items_unit-test: # name: Prepare all unit test items - uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/prepare_test_items.yaml@master + uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_get_tests.yaml@master with: shell_path: scripts/ci/get-unit-test-paths.sh shell_arg: unix @@ -67,7 +67,7 @@ And we could get this workflow output result via keyword _all_test_items_.
-### _run_test_items_via_pytest.yaml_ +### _rw_run_test.yaml_ * Description: Run testing by specific type with all test items via PyTest and generate its testing coverage report (it would save reports by _actions/upload-artifact@v3_). * Options: @@ -97,7 +97,7 @@ No, but it would save the testing coverage reports to provide after-process to o run_unit-test: # name: Run all unit test items needs: prepare-testing-items_unit-test - uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/run_test_items_via_pytest.yaml@master + uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_run_test.yaml@master with: test_type: unit-test all_test_items_paths: ${{needs.prepare-testing-items_unit-test.outputs.all_test_items}} @@ -121,21 +121,21 @@ is provided by previous workflow? That is all testing items. > **_NOTE:_** > > It also has another reusable workflow names _poetry_run_test_via_pytest.yaml_. If your Python project manages by **Poetry**, -> it recommends you to use this one replaces _run_test_items_via_pytest.yaml_. The usage and running details are mostly same -> as _run_test_items_via_pytest.yaml_. But, workflow _poetry_run_test_via_pytest.yaml_ only supports Python version 3.8 up. +> it recommends you to use this one replaces _rw_run_test.yaml_. The usage and running details are mostly same +> as _rw_run_test.yaml_. But, workflow _poetry_run_test_via_pytest.yaml_ only supports Python version 3.8 up. > -* Difference between workflows _run_test_items_via_pytest.yaml_ and _poetry_run_test_via_pytest.yaml_ +* Difference between workflows _rw_run_test.yaml_ and _poetry_run_test_via_pytest.yaml_ | Workflow | Running way | Support Python version | |-----------------------------------|---------------------------------------------------|------------------------| -| _run_test_items_via_pytest.yaml_ | Command lines like ``pip``, ``python``, etc | 3.6 - 3.11 | +| _rw_run_test.yaml_ | Command lines like ``pip``, ``python``, etc | 3.6 - 3.11 | | _poetry_run_test_via_pytest.yaml_ | Use ``poetry`` feature or run command lines in it | 3.8 - 3.11 |
-### _organize_and_generate_test_cov_reports.yaml_ +### _rw_organize_test_cov_reports.yaml_ * Description: Organize all the testing coverage reports which be generated in different runtime OS with Python version. (it would save reports by _actions/upload-artifact@v3_). * Options: @@ -159,7 +159,7 @@ No, but it would save the testing coverage reports to provide after-process to o unit-test_codecov: # name: Organize and generate the testing report and upload it to Codecov needs: run_unit-test - uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/organize_and_generate_test_cov_reports.yaml@master + uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_organize_test_cov_reports.yaml@master with: test_type: unit-test ``` @@ -168,7 +168,7 @@ It would upload the organized report via _actions/upload-artifact@v3_. And it do
-### _upload_test_cov_report.yaml_ +### _rw_upload_test_cov_report.yaml_ * Description: Upload the testing coverage reports to Codecov. * Options: @@ -215,7 +215,7 @@ Nothing. codecov_finish: # name: Organize and generate the testing report and upload it to Codecov needs: [unit-test_codecov] - uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/upload_test_cov_report.yaml@master + uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_upload_test_cov_report.yaml@master secrets: codecov_token: ${{ secrets.CODECOV_TOKEN }} with: @@ -237,7 +237,7 @@ Nothing. codecov_finish: # name: Organize and generate the testing report and upload it to Coveralls needs: [unit-test_codecov] - uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/upload_test_cov_report.yaml@master + uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_upload_test_cov_report.yaml@master secrets: coveralls_token: ${{ secrets.COVERALLS_TOKEN }} with: @@ -257,7 +257,7 @@ Nothing. codecov_finish: # name: Organize and generate the testing report and upload it to Codacy needs: [unit-test_codecov] - uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/upload_test_cov_report.yaml@master + uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_upload_test_cov_report.yaml@master secrets: codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }} with: @@ -272,7 +272,7 @@ Nothing.
-### _pre-building_test.yaml_ +### _rw_pre-building_test.yaml_ * Description: Test package by simple way after running setup.py script to install Python package * Options: @@ -292,9 +292,9 @@ No, nothing at all. * How to use it? ```yaml - pre-building_test: + rw_pre-building_test: # name: Check about it could work finely by installing the Python package with setup.py file - uses: ./.github/workflows/pre-building_test.yaml + uses: ./.github/workflows/rw_pre-building_test.yaml with: build-type: setuptools python_package_name: Test-GitHub-Action-workflow @@ -305,7 +305,7 @@ No, nothing at all.
-### _build_git-tag_and_create_github-release.yaml_ +### _rw_build_git-tag_and_create_github-release.yaml_ * Description: Build a git tag on a specific commit in every git branch. And create GitHub release if current git branch is 'master'. * Options: @@ -331,10 +331,10 @@ Yes, it has running result output. It would output the version which could provi * **_Python package_** usage case: ```yaml - build_git-tag_and_create_github-release: + rw_build_git-tag_and_create_github-release: # name: Build git tag and GitHub release if it needs for Python package project needs: [coveralls_finish, codacy_finish] - uses: ./.github/workflows/build_git-tag_and_create_github-release.yaml + uses: ./.github/workflows/rw_build_git-tag_and_create_github-release.yaml with: project_type: python-package project_name: test_gh_workflow @@ -345,10 +345,10 @@ Yes, it has running result output. It would output the version which could provi * **_GitHub Action reusable workflow_** usage case: ```yaml - build_git-tag_and_create_github-release: + rw_build_git-tag_and_create_github-release: # name: Build git tag and GitHub release if it needs for GitHub Action reusable workflow project needs: [coveralls_finish, codacy_finish] - uses: ./.github/workflows/build_git-tag_and_create_github-release.yaml + uses: ./.github/workflows/rw_build_git-tag_and_create_github-release.yaml with: project_type: github-action-reusable-workflow debug_mode: true @@ -360,7 +360,7 @@ The badge it generates:
-### _push_pkg_to_pypi.yaml_ +### _rw_push_pypi.yaml_ * Description: Compile source code and push the Python package to PyPI. (Official release the Python package) * Options: @@ -391,7 +391,7 @@ No, nothing at all. ```yaml push_python_pkg_to_pypi: # name: Upload the Python package files which has been compiled to PyPi - uses: ./.github/workflows/push_pkg_to_pypi.yaml + uses: ./.github/workflows/rw_push_pypi.yaml with: build-type: setuptools release-type: 'Official-Release'