You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/release_workflow.rst
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,24 +10,24 @@ Step-by-Step Guide
10
10
11
11
1. Python Package Implementation
12
12
--------------------------------
13
-
* **Starting Point:** The journey begins with the implementation of the `BO4E data model as a Python package <https://github.com/bo4e/BO4E-python/>`_.
13
+
* **Starting Point:** The journey begins with the implementation of the `BO4E data model as a Python package <https://github.com/bo4e/BO4E-python/>`__.
14
14
15
15
2. Release and Schema Generation
16
16
--------------------------------
17
17
* **Automatic Generation:** Upon releasing a new version of this Python package, a GitHub action automatically triggers.
18
18
* **JSON Schemas Creation:** This action generates JSON schemas, which are essential blueprints of the data model.
19
-
* **Storage:** These schemas are then stored in a dedicated repository, known as the `BO4E-Schemas Repository <https://github.com/bo4e/BO4E-Schemas>`_.
19
+
* **Storage:** These schemas are then stored in a dedicated repository, known as the `BO4E-Schemas Repository <https://github.com/bo4e/BO4E-Schemas>`__.
20
20
21
-
3. Optional Customization (BO4E-Schema-Tool)
21
+
3. Optional Customization (BO4E-CLI)
22
22
--------------------------------------------
23
23
* **Flexibility in Data Fields:** Initially, the JSON schemas contain only optional fields.
24
-
* **Setting Required Fields:** If you need to designate certain fields as mandatory, you can use the `BO4E-Schema-Tool Repository <https://github.com/bo4e/BO4E-Schema-Tool>`_.
25
-
* **Tool Functionality:** This repository houses a command-line interface (CLI) tool that assists in updating the JSON schema files to define required fields.
24
+
* **Setting Required Fields:** If you need to designate certain fields as mandatory, you can use the `BO4E-CLI <https://github.com/bo4e/BO4E-CLI?tab=readme-ov-file#bo4e-edit>`__.
25
+
* **More flexibility for your use-case:** Besides the required fields, the BO4E-CLI can do a lot more non-critical customization. I.e. the edits are only additive.
26
26
27
-
4. Code Generation (BO4E-Python-Generator)
27
+
4. Code Generation (BO4E-CLI)
28
28
------------------------------------------
29
29
* **Finalizing JSON Schemas:** Once you have the final version of the JSON schema files, it's time to generate code.
30
-
* **Pydantic Classes Creation:** Utilize tools like the `BO4E-Python-Generator<https://github.com/bo4e/BO4E-Python-Generator>`_, another CLI tool, to create Pydantic classes from the JSON schemas.
30
+
* **Pydantic Classes Creation:** Use the same `BO4E-CLI<https://github.com/bo4e/BO4E-CLI?tab=readme-ov-file#bo4e-generate>`__ to create Pydantic classes from the JSON schemas.
0 commit comments