Skip to content

Commit c55506a

Browse files
committed
✨ Add new version (v6) release info details.
1 parent 330ecdc commit c55506a

File tree

1 file changed

+18
-29
lines changed

1 file changed

+18
-29
lines changed
Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,29 @@
1-
### πŸŽ‰πŸŽŠ New feature
1+
### πŸŽ‰πŸŽŠ **New feature**
22
<hr>
33

4-
1. Add new reusable workflows.
5-
* _rw_poetry_run_test.yaml_: Running tests by PyTest through **_Poetry_**.
6-
* _rw_sonarqube_scan.yaml_: Trigger SonarQube to scan project.
7-
8-
2. Improve the shell script about getting all tests.
9-
* _rw_get_tests.yaml_: It could scan and get all test paths automatically without manually configure test directory path.
10-
11-
3. Add GitHub dependencies bot for managing GitHub Action dependencies automatically.
4+
1. Improve the reusable workflow and extract some common logic as new reusable workflows.
5+
* _rw_run_test.yaml_: Extract the logic about matrix values part.
6+
* _rw_run_test_with_multi_py_versions.yaml_: Use matrix to run test with multiple Python versions with different runtime OS.
7+
* _rw_poetry_run_test.yaml_: Extract the logic about matrix values part. (Same with _rw_run_test.yaml_ but use **Poetry**)
8+
* _rw_poetry_run_test_with_multi_py_versions.yaml_: Use matrix to run test with multiple Python versions with different runtime OS. (Same with _rw_run_test_with_multi_py_versions.yaml_ but use **Poetry**)
129

1310
### πŸ› βš™οΈ **Breaking Change**
1411
<hr>
1512

16-
1. Rename all reusable workflows to be more clear and simple and rule the naming.
17-
* If it's reusable workflow, it should be named start with ``rw_``.
18-
* If it's CI process for testing, it should be named start with ``test_``.
19-
* Below are the renaming of all reusable workflows:
20-
* _prepare_test_items.yaml_ -> _rw_get_tests.yaml_
21-
* _run_test_items_via_pytest.yaml_ -> _rw_run_test.yaml_
22-
* _poetry_run_test_via_pytest.yaml_ -> _rw_poetry_run_test.yaml_
23-
* _organize_and_generate_test_cov_reports.yaml_ -> _rw_organize_test_cov_reports.yaml_
24-
* _upload_test_cov_report.yaml_ -> _rw_upload_test_cov_report.yaml_
25-
* _sonarqube_scan.yaml_ -> _rw_sonarqube_scan.yaml_
26-
* _pre-building_test.yaml_ -> _rw_pre-building_test.yaml_
27-
* _build_git-tag_and_create_github-release.yaml_ -> _rw_build_git-tag_and_create_github-release.yaml_
28-
* _push_pkg_to_pypi.yaml_ -> _rw_push_pypi.yaml_
13+
1. Reusable workflows would ONLY run one Python version with one specific runtime OS.
14+
* The reusable workflows which would be effected:
15+
* _rw_run_test.yaml_
16+
* _rw_poetry_run_test.yaml_
2917

30-
2. Modify the git event listening condition of testing CI process which would only be run at some key point git event.
31-
32-
### πŸ› πŸ› **Bug Fix**
18+
### πŸ€–βš™οΈπŸ”§ **Improvement**
3319
<hr>
3420

35-
1. Fix issue of generating incorrect git tag from software version info.
21+
1. Upgrade the actions in workflow.
22+
* ``actions/checkout``
23+
* ``actions/setup-python``
3624

37-
### πŸ§ͺ🧬 **Refactor**
38-
<hr>
25+
2. Fix the issue about warning message it should upgrade _pip_.
26+
* Detail error message: ``[notice] A new release of pip is available: 23.0.1 -> 24.0 [notice] To update, run: python3.10 -m pip install --upgrade pip``.
3927

40-
1. Refactor the shell script for building git tag and GitHub release info.
28+
3. Let shell script about combining test coverage reports could be more flexible.
29+
* Remove the limitation of the test type must be ``unit-test``, ``integration-test`` or ``system-test``.

0 commit comments

Comments
Β (0)