Standards Release 1.29.1# Changed version number in intro markdown an…

…d master swagger files. Added entry for new version in changelog table. Create new empty releasenotes file. Added entry for previous version in archives table. Updated new_version_setup utils file to accept -ndiff command line parameter to not remove diff statements and fixed small bugs
ConsumerDataStandardsAustralia · Feb 19, 2024 · 6ec9618 · 6ec9618
1 parent a7e49d3
commit 6ec9618
Show file tree

Hide file tree

Showing 16 changed files with 107 additions and 19 deletions.
diff --git a/slate/source/includes/archives.md b/slate/source/includes/archives.md
@@ -10,6 +10,7 @@ The following table lists archived versions of the Consumer Data Standards.  The
 
 |Release Date|Version|Description|
 |-------------|-------|-----------|
+|<a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.29.0/'>21/12/2023</a> | 1.29.0 | <a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.29.0/'>Changes from maintenance iteration 17.  Also includes CX Standards changes to uplift Data Holder Dashboards and accommodate Business Consumers</a> |
 |<a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.28.0/'>10/11/2023</a> | 1.28.0 | <a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.28.0/'>Candidate standards arising from Decision 306 and updated draft non-bank lending standards</a> |
 |<a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.27.0/'>10/10/2023</a> | 1.27.0 | <a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.27.0/'>Changes arising from Decision 313 (Maintenance Iteration 16)</a> |
 |<a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.26.0/'>24/08/2023</a> | 1.26.0 | <a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.26.0/'>Changes to obligations for the implementation of Get Metrics</a> |

diff --git a/slate/source/includes/changelog.md b/slate/source/includes/changelog.md
@@ -10,6 +10,7 @@ The following table lists the changes made to these standards in reverse date or
 
 |Change Date|Version|Description|Detail of change|
 |-----------|-------|-----------|----------------|
+|TBC | 1.29.1 | Changes TBC | See [release notes](includes/releasenotes/releasenotes.1.29.1.html) and [Decision XXX](https://github.com/ConsumerDataStandardsAustralia/standards/issues/XXX) for details. |
 |21/12/2023 | 1.29.0 | Changes from maintenance iteration 17.  Also includes CX Standards changes to uplift Data Holder Dashboards and accommodate Business Consumers | See [release notes](includes/releasenotes/releasenotes.1.29.0.html), [Decision 318](https://github.com/ConsumerDataStandardsAustralia/standards/issues/318), [Decision 328](https://github.com/ConsumerDataStandardsAustralia/standards/issues/328), [Decision 333](https://github.com/ConsumerDataStandardsAustralia/standards/issues/333) and [Decision 334](https://github.com/ConsumerDataStandardsAustralia/standards/issues/334) for details. |
 |10/11/2023| 1.28.0 | Candidate standards arising from Decision 306 and updated draft non-bank lending standards | See [release notes](includes/releasenotes/releasenotes.1.28.0.html) and [Decision 306](https://github.com/ConsumerDataStandardsAustralia/standards/issues/306) for details. |
 |10/10/2023| 1.27.0 | Changes arising from Decision 313 (Maintenance Iteration 16) | See [release notes](includes/releasenotes/releasenotes.1.27.0.html) and [Decision 313](https://github.com/ConsumerDataStandardsAustralia/standards/issues/313) for details. |

diff --git a/slate/source/includes/introduction/_intro.md b/slate/source/includes/introduction/_intro.md
@@ -32,7 +32,7 @@ Some of these standards will be binding data standards under the Competition and
 
 ## Version
 
-These standards represent version 1.29.0 of the high level standards.  See the [versioning section](#versioning) for more information on how versions are managed in the standard.
+These standards represent version 1.29.1 of the high level standards.  See the [versioning section](#versioning) for more information on how versions are managed in the standard.
 
 ## Interpretation
 

diff --git a/slate/source/includes/releasenotes/releasenotes.1.29.1.html.md b/slate/source/includes/releasenotes/releasenotes.1.29.1.html.md
@@ -0,0 +1,80 @@
+---
+title: Consumer Data Standards - v1.29.1 Release Notes
+
+#language_tabs: # must be one of https://git.io/vQNgJ
+
+toc_footers:
+  - <a href='../../index.html'>Consumer Data Standards</a>
+
+search: false
+---
+
+# V1.29.1 Release Notes
+Release notes for version v1.29.1 of the [CDR Standards](../../index.html).
+
+## Changes Made
+### Change Requests
+
+This release addresses the following minor defects raised on [Standards Staging](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues):
+
+- [Staging Issue xxx - Description](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/xxx)
+
+This release addresses the following change requests raised on [Standards Maintenance](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues):
+
+- [Maintenance Issue xxx - Description](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/xxx)
+
+### Decision Proposals
+
+This release addresses the following Decision Proposals published on [Standards](https://github.com/ConsumerDataStandardsAustralia/standards/issues):
+
+- [Decision Proposal xxx - Description](https://github.com/ConsumerDataStandardsAustralia/standards/issues/xxx)
+
+## General Changes
+|Change|Description|Link|
+|------|-----------|----|
+
+
+## Introduction
+
+|Change|Description|Link|
+|------|-----------|----|
+
+
+## High Level Standards
+
+|Change|Description|Link|
+|------|-----------|----|
+
+## API End Points
+
+|Change|Description|Link|
+|------|-----------|----|
+
+## Information Security Profile
+
+|Change|Description|Link|
+|------|-----------|----|
+
+## Register Standards
+
+|Change|Description|Link|
+|------|-----------|----|
+
+## Consumer Experience
+
+|Change|Description|Link|
+|------|-----------|----|
+
+## Non-Functional Requirements
+
+|Change|Description|Link|
+|------|-----------|----|
+
+## Additional Standards
+
+|Change|Description|Link|
+|------|-----------|----|
+
+## Known Issues
+
+TBC
diff --git a/swagger-gen/api/cds_admin.json b/swagger-gen/api/cds_admin.json
@@ -12,7 +12,7 @@
       "name": "MIT License",
       "url": "https://opensource.org/licenses/MIT"
     },
-    "version": "1.29.0"
+    "version": "1.29.1"
   },
   "servers": [
     {

diff --git a/swagger-gen/api/cds_banking.json b/swagger-gen/api/cds_banking.json
@@ -12,7 +12,7 @@
       "name": "MIT License",
       "url": "https://opensource.org/licenses/MIT"
     },
-    "version": "1.29.0"
+    "version": "1.29.1"
   },
   "servers": [
     {

diff --git a/swagger-gen/api/cds_banking_dp306.json b/swagger-gen/api/cds_banking_dp306.json
@@ -12,7 +12,7 @@
       "name": "MIT License",
       "url": "https://opensource.org/licenses/MIT"
     },
-    "version": "1.29.0"
+    "version": "1.29.1"
   },
   "servers": [
     {

diff --git a/swagger-gen/api/cds_banking_non_bank_lending.json b/swagger-gen/api/cds_banking_non_bank_lending.json
@@ -12,7 +12,7 @@
       "name": "MIT License",
       "url": "https://opensource.org/licenses/MIT"
     },
-    "version": "1.29.0"
+    "version": "1.29.1"
   },
   "servers": [
     {

diff --git a/swagger-gen/api/cds_common.json b/swagger-gen/api/cds_common.json
@@ -12,7 +12,7 @@
       "name": "MIT License",
       "url": "https://opensource.org/licenses/MIT"
     },
-    "version": "1.29.0"
+    "version": "1.29.1"
   },
   "servers": [
     {

diff --git a/swagger-gen/api/cds_dcr.json b/swagger-gen/api/cds_dcr.json
@@ -3,7 +3,7 @@
   "info": {
     "title": "CDR Dynamic Client Registration API",
     "description": "This specification defines the APIs for Data Holders exposing Dynamic Client Registration endpoints.",
-    "version": "1.29.0"
+    "version": "1.29.1"
   },
   "servers": [
     {

diff --git a/swagger-gen/api/cds_energy.json b/swagger-gen/api/cds_energy.json
@@ -3,7 +3,7 @@
 	"info": {
 		"title": "CDR Energy API",
 		"description": "Consumer Data Right end points and payloads for the Energy sector",
-        "version": "1.29.0"
+        "version": "1.29.1"
 	},
 	"components": {
 		"schemas": {

diff --git a/swagger-gen/api/cds_energy_sdh.json b/swagger-gen/api/cds_energy_sdh.json
@@ -3,7 +3,7 @@
 	"info": {
 		"title": "CDR Energy Secondary Data Holder API",
 		"description": "Consumer Data Right end points and payloads for Secondary Data Holder for the Energy sector",
-        "version": "1.29.0"
+        "version": "1.29.1"
 	},
 	"components": {
 		"schemas": {

diff --git a/swagger-gen/api/cds_register.json b/swagger-gen/api/cds_register.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "CDR Participant Discovery API",
-    "version": "1.29.0"
+    "version": "1.29.1"
   },
   "servers": [
     {

diff --git a/swagger-gen/api/cds_register_banking_non_bank_lending.json b/swagger-gen/api/cds_register_banking_non_bank_lending.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "CDR Participant Discovery API",
-    "version": "1.29.0"
+    "version": "1.29.1"
   },
   "servers": [
     {

diff --git a/swagger-gen/api/cds_telco.json b/swagger-gen/api/cds_telco.json
@@ -12,7 +12,7 @@
       "url": "https://opensource.org/licenses/MIT"
     },
     "title": "CDR Telco API",
-    "version": "1.29.0"
+    "version": "1.29.1"
   },
   "servers": [ {
     "url": "https://data.holder.com.au/cds-au/v1"

diff --git a/utils/new_version_setup.py b/utils/new_version_setup.py
@@ -9,8 +9,8 @@
 new_version = "-1.-1.-1"
 current_version = "-2.-2.-2"
 exclude_list = ["_intro.md"] # Define the exclude_list for diff block removal
-changelog_table_header = "|Change Date|Version|Description|Detail Of change|"
-archives_table_header = "|Releases Date|Version|Description|"
+changelog_table_header = "|Change Date|Version|Description|Detail of change|"
+archives_table_header = "|Release Date|Version|Description|"
 SWAGGERGENAPIPATH = '../swagger-gen/api'
 INTROMDPATH = '../slate/source/includes/introduction/_intro.md'
 CHANGEPATH  = '../slate/source/includes/changelog.md'
@@ -35,7 +35,7 @@ def set_new_minor_version(content):
         new_minor = minor + 1
 
         # Construct the new version string
-        new_version = f"{major}.{new_minor}.{patch}"
+        new_version = f"{major}.{new_minor}.{0}"
 
         print(f"New Version: {new_version}")
         return new_version
@@ -93,7 +93,10 @@ def get_first_entry(file_path, table_header):
     # Extract the line immediately after the header (if it exists)
     if start_index != -1 and start_index + 1 < len(line):
         first_entry = line[start_index + 2]
-    return(first_entry)
+        return(first_entry)
+    else:
+        print("No first entry found in the changelog.")
+        return
 
 # Function to update the version number in a file
 def update_version_in_file(file_name):
@@ -207,7 +210,6 @@ def search_and_remove_diff_blocks(directory='.'):
                 remove_diff_blocks(file_path)
 
 
-
 def main():
 #   Get new version from user
     global new_version, current_version
@@ -255,8 +257,12 @@ def main():
     create_releasenotes()
     add_archives_entry()
     add_changelog_entry()
-#   Specify the directory where you want to start the search (default is the current directory)
-    search_and_remove_diff_blocks("../")
+    if "-ndiff" in sys.argv:
+        print("'-ndiff' argument provided. diff blocks will not be removed")
+    else:
+        print("removing diff blocks")
+    #   Specify the directory where you want to start the search (default is the current directory) as function argument 
+        search_and_remove_diff_blocks("../")
 
 if __name__ == "__main__":
     main()