Skip to content

Commit e6ffd41

Browse files
Chisanan232Chisanan232
authored
Merge pull request #500 from Chisanan232/develop/src-code_release_info
[CU-86et02ram] Officially release `0.4.2` version for the fake API server Python tool `PyFake-API-Server`.
2 parents 6f8ffa3 + f8ecf85 commit e6ffd41

6 files changed

Lines changed: 145 additions & 16 deletions

File tree

‎.github/tag_and_release/release-notes.md‎

Lines changed: 64 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,58 @@
11
### 🎉 New feature
22

3-
1. Support running fake server process in background and redirect the access log to the specific log file.
4-
1. ``--daemon``: daemonize the fake server process.
5-
2. ``--access-log-file``: redirect the fake server access log to the specific file.
3+
1. Support Python **3.13** version. ([PR#483])
4+
2. Add new value format properties:
5+
1. ``static_value``: New strategy for setting fixed value. ([PR#489])
6+
2. ``format.static_value``: The specific fixed value for the strategy ``static_value``, includes this property in `format.variable`. ([PR#489], [PR#490], [PR#491])
7+
3. ``format.unique_element``: Only for array type value which could generate unique elements in array type property, includes this property in `format.variable`. ([PR#494])
8+
3. Support API request could accept multiple different value formats, i.e., ISO format or Unix timestamp of datetime value. ([PR#488])
9+
10+
[PR#483]: https://github.com/Chisanan232/PyFake-API-Server/pull/483
11+
[PR#488]: https://github.com/Chisanan232/PyFake-API-Server/pull/488
12+
[PR#489]: https://github.com/Chisanan232/PyFake-API-Server/pull/489
13+
[PR#490]: https://github.com/Chisanan232/PyFake-API-Server/pull/490
14+
[PR#491]: https://github.com/Chisanan232/PyFake-API-Server/pull/491
15+
[PR#494]: https://github.com/Chisanan232/PyFake-API-Server/pull/494
16+
17+
18+
### 🔨 Breaking changes
19+
20+
1. Deprecate Python 3.8 version support, will remove all code in next version. ([PR#498])
621

722

823
### 🪲 Bug Fix
924

10-
1. Fix the issue about it cannot get the correct versioning info in documentation.
25+
#### 🙋‍♂️ For production
26+
27+
1. 💣 Critical bugs:
28+
1. Command line tool cannot work finely because filtering logic cannot cover all scenarios. ([PR#496])
29+
2. Command line tool cannot work finely because missing Python dependency. ([PR#498])
30+
2. 🦠 Major bugs:
31+
1. The request checking process: ([PR#493])
32+
1. Error messages are incorrect which would deeply mislead developers.
33+
2. The parameters data checking cannot work finely with array type parameters.
34+
2. It set incorrect customized value at format property with subcommand line `pull`. ([PR#487])
35+
3. Generate incorrect data structure in API response. ([PR#492])
36+
3. 🐛 Mirror bugs:
37+
1. Command line option `--include-template-config` cannot work under subcommand line `pull`. ([PR#485])
38+
2. Default value cannot be set correctly if it's empty string value. ([PR#484])
39+
40+
[PR#484]: https://github.com/Chisanan232/PyFake-API-Server/pull/484
41+
[PR#485]: https://github.com/Chisanan232/PyFake-API-Server/pull/485
42+
[PR#487]: https://github.com/Chisanan232/PyFake-API-Server/pull/487
43+
[PR#485]: https://github.com/Chisanan232/PyFake-API-Server/pull/485
44+
[PR#485]: https://github.com/Chisanan232/PyFake-API-Server/pull/485
45+
[PR#485]: https://github.com/Chisanan232/PyFake-API-Server/pull/485
46+
[PR#492]: https://github.com/Chisanan232/PyFake-API-Server/pull/492
47+
[PR#493]: https://github.com/Chisanan232/PyFake-API-Server/pull/493
48+
[PR#496]: https://github.com/Chisanan232/PyFake-API-Server/pull/496
49+
[PR#498]: https://github.com/Chisanan232/PyFake-API-Server/pull/498
50+
51+
#### 👨‍💻 For development
52+
53+
1. The file path regular expression is incorrect at documentation CI workflow. ([PR#499])
54+
55+
[PR#499]: https://github.com/Chisanan232/PyFake-API-Server/pull/499
1156

1257

1358
[//]: # (### ♻️ Refactor)
@@ -16,22 +61,30 @@
1661
[//]: # (1. content ...)
1762

1863

19-
[//]: # (### 🍀 Improvement)
64+
### 🍀 Improvement
2065

21-
[//]: # ()
22-
[//]: # (1. content ...)
66+
1. Clear the Pre-Commit configuration. ([PR#481])
67+
2. Clear the CI workflow configurations. ([PR#482])
68+
3. Let program could raise obvious error message if it misses some necessary values at initial process. ([PR#486])
69+
70+
[PR#481]: https://github.com/Chisanan232/PyFake-API-Server/pull/481
71+
[PR#482]: https://github.com/Chisanan232/PyFake-API-Server/pull/482
72+
[PR#486]: https://github.com/Chisanan232/PyFake-API-Server/pull/486
2373

2474

2575
### 📑 Docs
2676

27-
1. Update the content for new command line options.
77+
1. Update the content for new command line options. ([PR#487])
2878

79+
[PR#487]: https://github.com/Chisanan232/PyFake-API-Server/pull/497
2980

30-
### 🤖 Upgrade dependencies
3181

32-
[//]: # (1. Upgrade the Python dependencies.)
82+
[//]: # (### 🤖 Upgrade dependencies)
3383

34-
1. Upgrade pre-commit dependencies.
84+
[//]: # ()
85+
[//]: # ([//]: # (1. Upgrade the Python dependencies.))
86+
[//]: # ()
87+
[//]: # (1. Upgrade pre-commit dependencies.)
3588

3689
[//]: # (3. Upgrade the CI reusable workflows.)
3790

‎.github/tag_and_release/release-title.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v0.4.1 - Support run fake server in background 🍻
1+
v0.4.2 - Fix critical bugs and support new format properties 🍻

‎docs/release_note/version_0xx.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,81 @@
11
# Version 0.X.X
22

3+
## 0.4.2
4+
### 🎉 New feature
5+
6+
1. Support Python **3.13** version. ([PR#483])
7+
2. Add new value format properties:
8+
1. ``static_value``: New strategy for setting fixed value. ([PR#489])
9+
2. ``format.static_value``: The specific fixed value for the strategy ``static_value``, includes this property in `format.variable`. ([PR#489], [PR#490], [PR#491])
10+
3. ``format.unique_element``: Only for array type value which could generate unique elements in array type property, includes this property in `format.variable`. ([PR#494])
11+
3. Support API request could accept multiple different value formats, i.e., ISO format or Unix timestamp of datetime value. ([PR#488])
12+
13+
[PR#483]: https://github.com/Chisanan232/PyFake-API-Server/pull/483
14+
[PR#488]: https://github.com/Chisanan232/PyFake-API-Server/pull/488
15+
[PR#489]: https://github.com/Chisanan232/PyFake-API-Server/pull/489
16+
[PR#490]: https://github.com/Chisanan232/PyFake-API-Server/pull/490
17+
[PR#491]: https://github.com/Chisanan232/PyFake-API-Server/pull/491
18+
[PR#494]: https://github.com/Chisanan232/PyFake-API-Server/pull/494
19+
20+
21+
### 🔨 Breaking changes
22+
23+
1. Deprecate Python 3.8 version support, will remove all code in next version. ([PR#498])
24+
25+
26+
### 🪲 Bug Fix
27+
28+
#### 🙋‍♂️ For production
29+
30+
1. 💣 Critical bugs:
31+
1. Command line tool cannot work finely because filtering logic cannot cover all scenarios. ([PR#496])
32+
2. Command line tool cannot work finely because missing Python dependency. ([PR#498])
33+
2. 🦠 Major bugs:
34+
1. The request checking process: ([PR#493])
35+
1. Error messages are incorrect which would deeply mislead developers.
36+
2. The parameters data checking cannot work finely with array type parameters.
37+
2. It set incorrect customized value at format property with subcommand line `pull`. ([PR#487])
38+
3. Generate incorrect data structure in API response. ([PR#492])
39+
3. 🐛 Mirror bugs:
40+
1. Command line option `--include-template-config` cannot work under subcommand line `pull`. ([PR#485])
41+
2. Default value cannot be set correctly if it's empty string value. ([PR#484])
42+
43+
[PR#484]: https://github.com/Chisanan232/PyFake-API-Server/pull/484
44+
[PR#485]: https://github.com/Chisanan232/PyFake-API-Server/pull/485
45+
[PR#487]: https://github.com/Chisanan232/PyFake-API-Server/pull/487
46+
[PR#485]: https://github.com/Chisanan232/PyFake-API-Server/pull/485
47+
[PR#485]: https://github.com/Chisanan232/PyFake-API-Server/pull/485
48+
[PR#485]: https://github.com/Chisanan232/PyFake-API-Server/pull/485
49+
[PR#492]: https://github.com/Chisanan232/PyFake-API-Server/pull/492
50+
[PR#493]: https://github.com/Chisanan232/PyFake-API-Server/pull/493
51+
[PR#496]: https://github.com/Chisanan232/PyFake-API-Server/pull/496
52+
[PR#498]: https://github.com/Chisanan232/PyFake-API-Server/pull/498
53+
54+
#### 👨‍💻 For development
55+
56+
1. The file path regular expression is incorrect at documentation CI workflow. ([PR#499])
57+
58+
[PR#499]: https://github.com/Chisanan232/PyFake-API-Server/pull/499
59+
60+
61+
### 🍀 Improvement
62+
63+
1. Clear the Pre-Commit configuration. ([PR#481])
64+
2. Clear the CI workflow configurations. ([PR#482])
65+
3. Let program could raise obvious error message if it misses some necessary values at initial process. ([PR#486])
66+
67+
[PR#481]: https://github.com/Chisanan232/PyFake-API-Server/pull/481
68+
[PR#482]: https://github.com/Chisanan232/PyFake-API-Server/pull/482
69+
[PR#486]: https://github.com/Chisanan232/PyFake-API-Server/pull/486
70+
71+
72+
### 📑 Docs
73+
74+
1. Update the content for new command line options. ([PR#487])
75+
76+
[PR#487]: https://github.com/Chisanan232/PyFake-API-Server/pull/497
77+
78+
379
## 0.4.1
480

581
### 🎉 New feature

‎fake_api_server/__pkg_info__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
__title__ = "PyFake-API-Server"
1515
__description__ = "🕸🤖👺 A Python tool to fake server, e.g., RESTful API server, easily and humanly without any coding."
1616
__url__ = "https://chisanan232.github.io/PyFake-API-Server/stable/"
17-
__version__ = "0.4.1"
17+
__version__ = "0.4.2"
1818
__author__ = "Liu, Bryant"
1919
__author_email__ = "chi10211201@cycu.org.tw"
2020
__license__ = "MIT"

‎pyproject.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
44

55
[project]
66
name = "fake-api-server"
7-
version = "0.4.1"
7+
version = "0.4.2"
88
description = "🕸🤖👺 A Python tool to fake API server, e.g., RESTful API server, easily and humanly without any coding."
99
authors = [
1010
{ name = "Liu, Bryant", email = "chi10211201@cycu.org.tw" }
@@ -41,7 +41,7 @@ dependencies = [
4141
[tool.poetry]
4242
######## For GitHub dependency bot only #######
4343
#name = "fake-api-server"
44-
#version = "0.4.1"
44+
#version = "0.4.2"
4545
#description = "🕸🤖👺 A Python tool to fake API server, e.g., RESTful API server, easily and humanly without any coding."
4646
#authors = [
4747
# "Liu, Bryant <chi10211201@cycu.org.tw>",

‎sonar-project.properties‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sonar.organization=chisanan232
44

55
# This is the name and version displayed in the SonarCloud UI.
66
sonar.projectName=PyFake-API-Server
7-
sonar.projectVersion=0.4.1
7+
sonar.projectVersion=0.4.2
88

99
# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
1010
sonar.sources=fake_api_server/

0 commit comments

Comments
 (0)