Skip to content

Commit cddd995

Browse files
committed
[Docs] (docs) Add section of new reusable workflow 'pre-building_test.yaml'.
1 parent 5bd43f6 commit cddd995

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ The usage of each workflow template.
3131
* [_organize_and_generate_test_cov_reports.yaml_](#organize_and_generate_test_cov_reportsyaml)
3232
* [_upload_test_cov_report.yaml_](#upload_test_cov_reportyaml)
3333
* [_build_git-tag_and_create_github-release.yaml_](#build_git-tag_and_create_github-releaseyaml)
34+
* [_pre-building_test.yaml_](#pre-building_testyaml)
3435

3536
<hr>
3637

@@ -255,6 +256,38 @@ Nothing.
255256
256257
<hr>
257258
259+
### _pre-building_test.yaml_
260+
261+
* Description: Test package by simple way after running setup.py script to install Python package
262+
* Options:
263+
264+
| option name | data type | optional or required | function content |
265+
|----------------------------|-----------|-------------------------------------------|-----------------------------------------------------|
266+
| python_package_name | string | Required | The Python package name. |
267+
| test_import_package_code_1 | string | Optional, Default value is _empty string_ | Test for importing the Python package. |
268+
| test_import_package_code_2 | string | Optional, Default value is _empty string_ | Test for importing the Python package. |
269+
| test_import_package_code_3 | string | Optional, Default value is _empty string_ | Test for importing the Python package. |
270+
| test_python_script | string | Optional, Default value is _empty string_ | Run a Python script for testing the Python package. |
271+
272+
* Output:
273+
274+
No, nothing at all.
275+
276+
* How to use it?
277+
278+
```yaml
279+
pre-building_test:
280+
# name: Check about it could work finely by installing the Python package with setup.py file
281+
uses: ./.github/workflows/pre-building_test.yaml
282+
with:
283+
python_package_name: Test-GitHub-Action-workflow
284+
test_import_package_code_1: from test_gh_workflow import sample
285+
test_import_package_code_2: sample.hello_python()
286+
test_python_script: ./scripts/ci/test/test_pgk_install.py
287+
```
288+
289+
<hr>
290+
258291
### _build_git-tag_and_create_github-release.yaml_
259292
260293
* Description: Build a git tag on a specific commit in every git branch. And create GitHub release if current git branch is 'master'.

0 commit comments

Comments
 (0)