@@ -26,18 +26,18 @@ this project. This project has some workflow templates for reusing in GitHub Act
2626
2727The usage of each workflow template.
2828
29- * [ _ prepare_test_items .yaml_ ] ( #prepare_test_itemsyaml )
30- * [ _ run_test_items_via_pytest .yaml_ ] ( #run_test_items_via_pytestyaml )
31- * [ _ organize_and_generate_test_cov_reports .yaml_ ] ( #organize_and_generate_test_cov_reportsyaml )
32- * [ _ upload_test_cov_report .yaml_ ] ( #upload_test_cov_reportyaml )
33- * [ _ pre -building_test.yaml_ ] ( #pre -building_testyaml )
34- * [ _ build_git -tag_and_create_github-release.yaml_ ] ( #build_git -tag_and_create_github-releaseyaml )
35- * [ _ push_pkg_to_pypi .yaml_ ] ( #push_pkg_to_pypiyaml )
29+ * [ _ rw_get_tests .yaml_ ] ( #rw_get_testsyaml )
30+ * [ _ rw_run_test .yaml_ ] ( #rw_run_testyaml )
31+ * [ _ rw_organize_test_cov_reports .yaml_ ] ( #rw_organize_test_cov_reportsyaml )
32+ * [ _ rw_upload_test_cov_report .yaml_ ] ( #rw_upload_test_cov_reportyaml )
33+ * [ _ rw_pre -building_test.yaml_ ] ( #rw_pre -building_testyaml )
34+ * [ _ rw_build_git -tag_and_create_github-release.yaml_ ] ( #rw_build_git -tag_and_create_github-releaseyaml )
35+ * [ _ rw_push_pypi .yaml_ ] ( #rw_push_pypiyaml )
3636
3737<hr >
3838
3939
40- ### _ prepare_test_items .yaml_
40+ ### _ rw_get_tests .yaml_
4141
4242* Description: Prepare the test items.
4343* Options:
@@ -57,7 +57,7 @@ Before use this workflow, it should prepare a shell script for getting the testi
5757``` yaml
5858 prepare-testing-items_unit-test :
5959# name: Prepare all unit test items
60- uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/prepare_test_items .yaml@master
60+ uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_get_tests .yaml@master
6161 with :
6262 shell_path : scripts/ci/get-unit-test-paths.sh
6363 shell_arg : unix
@@ -67,7 +67,7 @@ And we could get this workflow output result via keyword _all_test_items_.
6767
6868<hr>
6969
70- ### _run_test_items_via_pytest .yaml_
70+ ### _rw_run_test .yaml_
7171
7272* 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_).
7373* Options:
@@ -97,7 +97,7 @@ No, but it would save the testing coverage reports to provide after-process to o
9797 run_unit-test :
9898# name: Run all unit test items
9999 needs : prepare-testing-items_unit-test
100- uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/run_test_items_via_pytest .yaml@master
100+ uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_run_test .yaml@master
101101 with :
102102 test_type : unit-test
103103 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.
121121> **_NOTE:_**
122122>
123123> It also has another reusable workflow names _poetry_run_test_via_pytest.yaml_. If your Python project manages by **Poetry**,
124- > it recommends you to use this one replaces _run_test_items_via_pytest .yaml_. The usage and running details are mostly same
125- > as _run_test_items_via_pytest .yaml_. But, workflow _poetry_run_test_via_pytest.yaml_ only supports Python version 3.8 up.
124+ > it recommends you to use this one replaces _rw_run_test .yaml_. The usage and running details are mostly same
125+ > as _rw_run_test .yaml_. But, workflow _poetry_run_test_via_pytest.yaml_ only supports Python version 3.8 up.
126126>
127127
128- * Difference between workflows _run_test_items_via_pytest .yaml_ and _poetry_run_test_via_pytest.yaml_
128+ * Difference between workflows _rw_run_test .yaml_ and _poetry_run_test_via_pytest.yaml_
129129
130130| Workflow | Running way | Support Python version |
131131|-----------------------------------|---------------------------------------------------|------------------------|
132- | _run_test_items_via_pytest .yaml_ | Command lines like ` ` pip` ` , ` ` python` ` , etc | 3.6 - 3.11 |
132+ | _rw_run_test .yaml_ | Command lines like ` ` pip` ` , ` ` python` ` , etc | 3.6 - 3.11 |
133133| _poetry_run_test_via_pytest.yaml_ | Use ` ` poetry` ` feature or run command lines in it | 3.8 - 3.11 |
134134
135135
136136<hr>
137137
138- ### _organize_and_generate_test_cov_reports .yaml_
138+ ### _rw_organize_test_cov_reports .yaml_
139139
140140* 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_).
141141* Options:
@@ -159,7 +159,7 @@ No, but it would save the testing coverage reports to provide after-process to o
159159 unit-test_codecov :
160160# name: Organize and generate the testing report and upload it to Codecov
161161 needs : run_unit-test
162- uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/organize_and_generate_test_cov_reports .yaml@master
162+ uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_organize_test_cov_reports .yaml@master
163163 with :
164164 test_type : unit-test
165165` ` `
@@ -168,7 +168,7 @@ It would upload the organized report via _actions/upload-artifact@v3_. And it do
168168
169169<hr>
170170
171- ### _upload_test_cov_report .yaml_
171+ ### _rw_upload_test_cov_report .yaml_
172172
173173* Description: Upload the testing coverage reports to Codecov.
174174* Options:
@@ -215,7 +215,7 @@ Nothing.
215215 codecov_finish :
216216 # name: Organize and generate the testing report and upload it to Codecov
217217 needs : [unit-test_codecov]
218- uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/upload_test_cov_report .yaml@master
218+ uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_upload_test_cov_report .yaml@master
219219 secrets :
220220 codecov_token : ${{ secrets.CODECOV_TOKEN }}
221221 with :
@@ -237,7 +237,7 @@ Nothing.
237237 codecov_finish :
238238 # name: Organize and generate the testing report and upload it to Coveralls
239239 needs : [unit-test_codecov]
240- uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/upload_test_cov_report .yaml@master
240+ uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_upload_test_cov_report .yaml@master
241241 secrets :
242242 coveralls_token : ${{ secrets.COVERALLS_TOKEN }}
243243 with :
@@ -257,7 +257,7 @@ Nothing.
257257 codecov_finish :
258258 # name: Organize and generate the testing report and upload it to Codacy
259259 needs : [unit-test_codecov]
260- uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/upload_test_cov_report .yaml@master
260+ uses : Chisanan232/GitHub-Action-Template-Python/.github/workflows/rw_upload_test_cov_report .yaml@master
261261 secrets :
262262 codacy_token : ${{ secrets.CODACY_PROJECT_TOKEN }}
263263 with :
@@ -272,7 +272,7 @@ Nothing.
272272
273273<hr>
274274
275- ### _pre -building_test.yaml_
275+ ### _rw_pre -building_test.yaml_
276276
277277* Description: Test package by simple way after running setup.py script to install Python package
278278* Options:
@@ -292,9 +292,9 @@ No, nothing at all.
292292* How to use it?
293293
294294` ` ` yaml
295- pre -building_test :
295+ rw_pre -building_test :
296296# name: Check about it could work finely by installing the Python package with setup.py file
297- uses : ./.github/workflows/pre -building_test.yaml
297+ uses : ./.github/workflows/rw_pre -building_test.yaml
298298 with :
299299 build-type : setuptools
300300 python_package_name : Test-GitHub-Action-workflow
@@ -305,7 +305,7 @@ No, nothing at all.
305305
306306<hr>
307307
308- ### _build_git -tag_and_create_github-release.yaml_
308+ ### _rw_build_git -tag_and_create_github-release.yaml_
309309
310310* Description: Build a git tag on a specific commit in every git branch. And create GitHub release if current git branch is 'master'.
311311* Options:
@@ -331,10 +331,10 @@ Yes, it has running result output. It would output the version which could provi
331331 * **_Python package_** usage case:
332332
333333 ` ` ` yaml
334- build_git -tag_and_create_github-release :
334+ rw_build_git -tag_and_create_github-release :
335335 # name: Build git tag and GitHub release if it needs for Python package project
336336 needs : [coveralls_finish, codacy_finish]
337- uses : ./.github/workflows/build_git -tag_and_create_github-release.yaml
337+ uses : ./.github/workflows/rw_build_git -tag_and_create_github-release.yaml
338338 with :
339339 project_type : python-package
340340 project_name : test_gh_workflow
@@ -345,10 +345,10 @@ Yes, it has running result output. It would output the version which could provi
345345 * **_GitHub Action reusable workflow_** usage case:
346346
347347 ` ` ` yaml
348- build_git -tag_and_create_github-release :
348+ rw_build_git -tag_and_create_github-release :
349349 # name: Build git tag and GitHub release if it needs for GitHub Action reusable workflow project
350350 needs : [coveralls_finish, codacy_finish]
351- uses : ./.github/workflows/build_git -tag_and_create_github-release.yaml
351+ uses : ./.github/workflows/rw_build_git -tag_and_create_github-release.yaml
352352 with :
353353 project_type : github-action-reusable-workflow
354354 debug_mode : true
@@ -360,7 +360,7 @@ The badge it generates:
360360
361361<hr>
362362
363- ### _push_pkg_to_pypi .yaml_
363+ ### _rw_push_pypi .yaml_
364364
365365* Description: Compile source code and push the Python package to PyPI. (Official release the Python package)
366366* Options:
@@ -391,7 +391,7 @@ No, nothing at all.
391391` ` ` yaml
392392 push_python_pkg_to_pypi :
393393# name: Upload the Python package files which has been compiled to PyPi
394- uses : ./.github/workflows/push_pkg_to_pypi .yaml
394+ uses : ./.github/workflows/rw_push_pypi .yaml
395395 with :
396396 build-type : setuptools
397397 release-type : ' Official-Release'
0 commit comments