chore: make it easier to generate changelog on release (#660)

use jinja2 templates to allow for automatic generation updated last 6 changelogs that were missing Refs: ECALC-1630
equinor · Oct 23, 2024 · 66c7c10 · 66c7c10
1 parent 68ef074
commit 66c7c10
Show file tree

Hide file tree

Showing 12 changed files with 122 additions and 190 deletions.
diff --git a/docs/config/meta.json b/docs/config/meta.json
@@ -0,0 +1 @@
+{"current_index": -36}
diff --git a/docs/docs/changelog/meta.json b/docs/docs/changelog/meta.json
diff --git a/docs/docs/changelog/separator.md b/docs/docs/changelog/separator.md
diff --git a/docs/docs/changelog/v8-21.md b/docs/docs/changelog/v8-21.md
@@ -1,9 +1,9 @@
 ---
 slug: v8.21-release
-title: v8.21 (Latest)
+title: v8.21
 authors: ecalc-team
 tags: [release, eCalc]
-sidebar_position: -1001
+sidebar_position: -30
 ---
 
 # eCalc

diff --git a/docs/docs/changelog/next.md → docs/docs/changelog/v8-22.md b/docs/docs/changelog/next.md → docs/docs/changelog/v8-22.md
@@ -1,14 +1,12 @@
 ---
-slug: latest
-title: Next
+slug: "v8.22-release"
+title: "v8.22"
 authors: ecalc-team
 tags: [release, eCalc]
-sidebar_position: -1002
+sidebar_position: -31
 ---
 
-# eCalc
-
-
+# eCalc v8.22
 
 ## New Features
 
@@ -21,28 +19,18 @@ sidebar_position: -1002
   is any downstream choking, this will happen between the outlet of the last compressor stage and the outlet of the
   compressor train. This means that in a situation with downstream choking, the fluid stream leaving the compressor
   train will have lower e.g. pressure and density than the fluid stream leaving the last compressor stage.
-- `POWER_ADJUSTMENT_FACTOR` for models: Optional factor to adjust the power (MW). Previously only the
-  `POWER_ADJUSTMENT_CONSTANT` has been available for models, now it is possible to adjust/scale the power with a
-  constant and a factor. It can be used to calibrate equipment.
 
-## Fixes
+
+## Bug Fixes
 
 - If a compressor train is not able to reach the requested inlet or outlet pressure, both the compressor stages and
   the compressor train used to be reported as invalid. This is now changed. If the compressor stages are operating within
   their capacity, they will now be reported as valid even if the compressor train as a whole is not able to reach
   the requested inlet or outlet pressures.
 
-- Emission intensities are no longer calculated and reported in the results, due to the following discrepancies:
-CO2 intensity is defined as the total emission divided by the total HC export. eCalc only calculates the future data, so the correct CO2 intensity should be found by adding the historical to these future data. The hydrocarbon export rate is still reported to help the user calculate the CO2 intensity outside of eCalc.
-Methane intensity was incorrectly calculated based on HC export. The common definition is the methane emission divided by the natural gas throughput of the wanted equipment- or installation level. This is safest done outside of eCalc to ensure proper definition.
 ## Breaking changes
 
 - This version includes a rewrite of the yaml validation, which should catch more errors than before.
-
-    Main changes:
-    - Economics has been removed. TAX, PRICE and QUOTA keywords will now give an error.
-    - Misplaced keywords will now cause an error instead of being ignored.
-
-- H2O is no longer supported in composition. Use 'water' instead.
-
-- The CLI command `ecalc show results` has been removed. The reason being additional maintenance for something that did not seem to be used a lot.
+- Economics has been removed. TAX, PRICE and QUOTA keywords will now give an error.
+- Misplaced keywords will now cause an error instead of being ignored.
+
diff --git a/docs/docs/changelog/v8-23.md b/docs/docs/changelog/v8-23.md
@@ -0,0 +1,23 @@
+---
+slug: "v8.23-release"
+title: "v8.23"
+authors: ecalc-team
+tags: [release, eCalc]
+sidebar_position: -32
+---
+
+# eCalc v8.23
+
+## Features
+
+- `POWER_ADJUSTMENT_FACTOR` for models: Optional factor to adjust the power (MW). Previously only the
+  `POWER_ADJUSTMENT_CONSTANT` has been available for models, now it is possible to adjust/scale the power with a
+  constant and a factor. It can be used to calibrate equipment.
+
+## Bug Fixes
+
+- Default pressure control was added to variable speed train, but missing for single speed and multiple streams.
+
+## Breaking changes
+
+- H2O is no longer supported in composition. Use 'water' instead.
diff --git a/docs/docs/changelog/v8-24.md b/docs/docs/changelog/v8-24.md
@@ -0,0 +1,17 @@
+---
+slug: "v8.24-release"
+title: "v8.24"
+authors: ecalc-team
+tags: [release, eCalc]
+sidebar_position: -33
+---
+
+# eCalc v8.24
+
+Security updates only.
+
+## Features
+
+## Bug Fixes
+
+## Breaking changes
diff --git a/docs/docs/changelog/v8-25.md b/docs/docs/changelog/v8-25.md
@@ -0,0 +1,17 @@
+---
+slug: "v8.25-release"
+title: "v8.25"
+authors: ecalc-team
+tags: [release, eCalc]
+sidebar_position: -34
+---
+
+# eCalc v8.25
+
+## Features
+
+## Bug Fixes
+
+## Breaking changes
+
+- The CLI command `ecalc show results` has been removed. The reason being additional maintenance for something that did not seem to be used a lot.
diff --git a/docs/docs/changelog/v8-26.md b/docs/docs/changelog/v8-26.md
@@ -0,0 +1,22 @@
+---
+slug: "v8.26-release"
+title: "v8.26"
+authors: ecalc-team
+tags: [release, eCalc]
+sidebar_position: -35
+---
+
+# eCalc v8.26
+
+## Features
+
+## Bug Fixes
+
+- Emission intensities are no longer calculated and reported in the results, due to the following discrepancies:
+CO2 intensity is defined as the total emission divided by the total HC export. eCalc only calculates the future data, so the correct CO2 intensity should be found by adding the historical to these future data. The hydrocarbon export rate is still reported to help the user calculate the CO2 intensity outside of eCalc.
+Methane intensity was incorrectly calculated based on HC export. The common definition is the methane emission divided by the natural gas throughput of the wanted equipment- or installation level. This is safest done outside of eCalc to ensure proper definition.
+
+
+## Breaking changes
+
+
diff --git a/docs/drafts/next.draft.md b/docs/drafts/next.draft.md
@@ -0,0 +1,15 @@
+---
+slug: "{{ version_slug }}"
+title: "{{ version_title }}"
+authors: ecalc-team
+tags: [release, eCalc]
+sidebar_position: -36
+---
+
+# eCalc {{ version }}
+
+## Features
+
+## Bug Fixes
+
+## Breaking changes
diff --git a/docs/src/pages/versions.tsx b/docs/src/pages/versions.tsx
diff --git a/docs/templates/next.md.template b/docs/templates/next.md.template
@@ -0,0 +1,16 @@
+---
+slug: "{{ version_slug }}"
+title: "{{ version_title }}"
+authors: ecalc-team
+tags: [release, eCalc]
+sidebar_position: {{ index }}
+---
+
+# eCalc {{ version }}
+
+## Features
+
+## Bug Fixes
+
+## Breaking changes
+