Menu ▾ ▴

#579 Package creator projects

v1.1.x
closed
Erik Hänel
None
v1.1.3
New Functionality
2021-07-12
2021-05-05
Erik Hänel
No

The package creator needs the possibility to store its settings in a project file, which can be loaded at any time to make adaptions to the already performed configurations. This would make package deployment much easier. Even more, the version <auto> could then have a real purpose as it would result in reasonable version increment every time the package is created.

Analysis:

We use XML as file format for the new NPKP (NumeRe package project) files. The advantage is, that we can make use of tinyXML-2 as a stable and robust library and we can avoid to write a new file type implementation. The XML files shall contain all install info settings and the file list. It might be helpful to provide a simple XML editor to store the documentation in the project or as a separate file.

The <auto> versioning will be represented in the project files, which will increment the package version automatically on project load by one build count.

Implementation:

  • Implementation: Was implemented as proposed by the analysis.
  • Revision: [r869] and [r870]
  • Implementation test: Projects were created, and checked for loading, saving. File existence checks during loading were performed and worked as expected.

Documentation:

  • [x] ChangesLog updated
  • [x] Code changes commented
  • Documentation articles:
    • [ ] corresponding documentation articles updated
    • [ ] new documentation articles created
    • [x] not needed
  • Language files:
    • [x] corresponding language files updated
    • [ ] not needed

Tests:

Feature works as intended. No deviation detected.

Related

Commit: [r869]
Commit: [r870]

Discussion

  • Erik Hänel

    Erik Hänel - 2021-05-05
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2021-05-08
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 The package creator needs the possibility to store its settings in a project file, which can be loaded at any time to make adaptions to the already performed configurations. This would make package deployment much easier. Even more, the version `&lt;auto&gt;` could then have a real purpose as it would result in reasonable version increment every time the package is created.
+
+###Analysis:
+(*Describe, what&#39;s the issue and which changes have to be made*)
+
+###Implementation:
+* Implementation: (*Describe, what you&#39;ve changed*) 
+* Revision: [rXXX]
+* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+
+###Documentation:
+* [ ] ChangesLog updated
+* [ ] Code changes commented
+* **Documentation articles:**

+    * [ ] corresponding documentation articles updated
+    * [ ] new documentation articles created
+    * [ ] not needed
+* **Language files:**
+    * [ ] corresponding language files updated
+    * [ ] not needed
+
+###Tests:
+(*Describe, which tests you performed and their outcome*)
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2021-05-10
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,9 @@
 The package creator needs the possibility to store its settings in a project file, which can be loaded at any time to make adaptions to the already performed configurations. This would make package deployment much easier. Even more, the version `&lt;auto&gt;` could then have a real purpose as it would result in reasonable version increment every time the package is created.

 ###Analysis:
-(*Describe, what&#39;s the issue and which changes have to be made*)
+We use XML as file format for the new NPKP (NumeRe package project) files. The advantage is, that we can make use of tinyXML-2 as a stable and robust library  and we can avoid to write a new file type implementation. The XML files shall contain all install info settings and the file list. It might be helpful to provide a simple XML editor to store the documentation in the project or as a separate file.
+
+The `&lt;auto&gt;` versioning will be represented in the project files, which will increment the package version automatically on project load by one build count.

 ###Implementation:

 * Implementation: (*Describe, what you&#39;ve changed*)
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2021-05-15
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -6,19 +6,19 @@
 The `&lt;auto&gt;` versioning will be represented in the project files, which will increment the package version automatically on project load by one build count.

 ###Implementation:
-* Implementation: (*Describe, what you&#39;ve changed*) 
-* Revision: [rXXX]
-* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+* Implementation: Was implemented as proposed by the analysis.
+* Revision: [r869] and [r870]
+* Implementation test: Projects were created, and checked for loading, saving. File existence checks during loading were performed and worked as expected.

 ###Documentation:
-* [ ] ChangesLog updated
-* [ ] Code changes commented
+* [x] ChangesLog updated
+* [x] Code changes commented

 * **Documentation articles:**
     * [ ] corresponding documentation articles updated
     * [ ] new documentation articles created
-    * [ ] not needed
+    * [x] not needed
 * **Language files:**
-    * [ ] corresponding language files updated
+    * [x] corresponding language files updated
     * [ ] not needed

 ###Tests:
    • status: implementing --> testing
     

    Related

    Commit: [r869]
    Commit: [r870]

  • Erik Hänel

    Erik Hänel - 2021-07-12
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -22,4 +22,4 @@

     * [ ] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+Feature works as intended. No deviation detected.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB