Prepare for v1.0.0-rc.1 release candidate (#109)

Signed-off-by: hoangtungdinh <[email protected]> Co-authored-by: hoangtungdinh <[email protected]>
asam-ev · Oct 31, 2024 · e6f0d9e · e6f0d9e
1 parent 18ff96e
commit e6f0d9e
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 This project implements the [ASAM OpenDrive Checker Bundle](checker_bundle_doc.md).
 
+**Disclaimer**: The current version is a release candidate. The first official release is expected to be in November.
+
 - [asam-qc-opendrive](#asam-qc-opendrive)
   - [Installation and usage](#installation-and-usage)
     - [Installation using pip](#installation-using-pip)
@@ -254,8 +256,41 @@ You need to have pre-commit installed and install the hooks:
 pre-commit install
 ```
 
+**Valid and invalid example OpenDrive files for future rules**
+
 [This folder](tests/data/not_implemented_yet/) contains the valid and invalid sample OpenDrive files of the
 rules that need to be implemented in the future. It can be used as a reference for anyone who
 wants to contribute to the implementation of the rules.
 
 Contributions of valid and invalid OpenDrive sample files are also welcome. New sample files can be added to [the same folder](tests/data/not_implemented_yet/).
+
+**To implement a new checker**
+
+1. Create a new Python module for each checker.
+2. Specify the following global variables for the Python module
+
+| Variable | Meaning |
+| --- | --- |
+| `CHECKER_ID` | The ID of the checker |
+| `CHECKER_DESCRIPTION` | The description of the checker |
+| `CHECKER_PRECONDITIONS` | A set of other checkers in which if any of them raise an issue, the current checker will be skipped |
+| `RULE_UID` | The rule UID of the rule that the checker will check |
+
+3. Implement the checker logic in the following function:
+
+```python
+def check_rule(checker_data: models.CheckerData) -> None:
+    pass
+```
+
+4. Register the checker module in the following function in [main.py](qc_opendrive/main.py).
+
+```python
+def run_checks(config: Configuration, result: Result) -> None:
+    ...
+    # Add the following line to register your checker module
+    execute_checker(your_checker_module, checker_data)
+    ...
+```
+
+All the checkers in this checker bundle are implemented in this way. Take a look at some of them before implementing your first checker.
diff --git a/checker_bundle_doc.md b/checker_bundle_doc.md
@@ -1,11 +1,12 @@
 # Checker bundle: xodrBundle
 
-* Build version:  0.1.0
+* Build version:  v1.0.0-rc.1
 * Description:    OpenDrive checker bundle
 
 ## Parameters
 
 * InputFile
+* resultFile
 
 ## Checkers
 

diff --git a/manifest_templates/windows_xodr_manifest.json b/manifest_templates/windows_xodr_manifest.json
@@ -4,7 +4,7 @@
       "name": "xodrBundle",
       "exec_type": "executable",
       "module_type": "checker_bundle",
-      "exec_command": "cd %ASAM_QC_FRAMEWORK_WORKING_DIR% && qc_opendrive -c %ASAM_QC_FRAMEWORK_CONFIG_FILE%"
+      "exec_command": "cd \"%ASAM_QC_FRAMEWORK_WORKING_DIR%\" && qc_opendrive -c \"%ASAM_QC_FRAMEWORK_CONFIG_FILE%\""
     }
   ]
 }
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "asam-qc-opendrive"
-version = "0.1.0"
+version = "1.0.0rc1"
 description = "This project implements the OpenDrive Checker for the ASAM Quality Checker project."
 authors = ["Patrick Abrahão <[email protected]>", "Tung Dinh <[email protected]>"]
 license = "MPL-2.0"

diff --git a/qc_opendrive/constants.py b/qc_opendrive/constants.py
@@ -1,2 +1,2 @@
 BUNDLE_NAME = "xodrBundle"
-BUNDLE_VERSION = "0.1.0"
+BUNDLE_VERSION = "v1.0.0-rc.1"
diff --git a/qc_opendrive/main.py b/qc_opendrive/main.py
@@ -213,7 +213,6 @@ def main():
     result = Result()
     result.register_checker_bundle(
         name=constants.BUNDLE_NAME,
-        build_date="2024-06-05",
         description="OpenDrive checker bundle",
         version=constants.BUNDLE_VERSION,
         summary="",