Merge branch 'master' into GT-1035-Integrate-caching-solution

wearefrank · Aug 12, 2024 · 970c946 · 970c946
2 parents 7627f94 + 36758e1
commit 970c946
Show file tree

Hide file tree

Showing 13 changed files with 3,377 additions and 18 deletions.
diff --git a/.github/workflows/bump-ff-version.yml b/.github/workflows/bump-ff-version.yml
@@ -0,0 +1,21 @@
+name: Bump F!F Version
+
+on:
+  workflow_dispatch:
+    schedule:
+      - cron: '0 5 * * 1' # At 05:00 on Monday.
+    inputs:
+      ff-version-tag:
+        description: 'F!F version tag requested to update in your project to. It has to be after 8.0.1(including).'    
+        required: true
+        default: 'latest'
+
+jobs:
+  bump-ff-version:
+    uses: wearefrank/ci-cd-templates/.github/workflows/ff-version-auto-bumper.yml@5ec30763e8d8eeed008edcac3c6a329367e42760 # 1.0.4
+    secrets:
+      token: ${{ secrets.WEAREFRANK_BOT_PAT }}
+      dockerhub-username: ${{ secrets.DOCKERHUB_USERNAME }}
+      dockerhub-token: ${{ secrets.DOCKERHUB_TOKEN }}
+    with:
+      ff-version-tag: ${{ github.event.inputs.ff-version-tag || 'latest' }}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,7 +15,7 @@ jobs:
       version-next: ${{ steps.reference.outputs.next-reference }}
       version-next-strict: ${{ steps.reference.outputs.next-reference }}
     steps:
-      - uses: step-security/harden-runner@17d0e2bd7d51742c71671bd19fa12bdc9d40a3d6 # v2.8.1
+      - uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0
         with:
           disable-sudo: true
           egress-policy: block
@@ -27,10 +27,10 @@ jobs:
 
       - name: Next Reference
         id: reference
-        uses: wearefrank/ci-cd-templates/next-reference@e8affe3c6b9d1a725b3332042f82096286974d15 #1.0.2
+        uses: wearefrank/ci-cd-templates/next-reference@5ec30763e8d8eeed008edcac3c6a329367e42760 #1.0.4
 
   ci:
-    uses: wearefrank/ci-cd-templates/.github/workflows/ci-generic.yml@e8affe3c6b9d1a725b3332042f82096286974d15 #1.0.2
+    uses: wearefrank/ci-cd-templates/.github/workflows/ci-generic.yml@5ec30763e8d8eeed008edcac3c6a329367e42760 #1.0.4
     needs:
       - version-next
     secrets:
@@ -48,7 +48,7 @@ jobs:
       - version-next
       - ci
     steps:
-      - uses: step-security/harden-runner@17d0e2bd7d51742c71671bd19fa12bdc9d40a3d6 # v2.8.1
+      - uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0
         with:
           egress-policy: audit
 

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -14,7 +14,7 @@ jobs:
       version-next-tag: ${{ steps.next-version.outputs.release-tag }}
       version-next-type: ${{ steps.next-version.outputs.release-type }}
     steps:
-      - uses: step-security/harden-runner@17d0e2bd7d51742c71671bd19fa12bdc9d40a3d6 # v2.8.1
+      - uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0
         with:
           disable-sudo: true
           egress-policy: audit
@@ -40,7 +40,7 @@ jobs:
           GH_TOKEN: ${{ secrets.WEAREFRANK_BOT_PAT }}
 
   ci:
-    uses: wearefrank/ci-cd-templates/.github/workflows/ci-generic.yml@e8affe3c6b9d1a725b3332042f82096286974d15 #1.0.2
+    uses: wearefrank/ci-cd-templates/.github/workflows/ci-generic.yml@5ec30763e8d8eeed008edcac3c6a329367e42760 #1.0.4
     needs: analyze-commits
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}
@@ -58,7 +58,7 @@ jobs:
       - analyze-commits
       - ci
     steps:
-      - uses: step-security/harden-runner@17d0e2bd7d51742c71671bd19fa12bdc9d40a3d6 # v2.8.1
+      - uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0
         with:
           egress-policy: audit
 
@@ -127,7 +127,7 @@ jobs:
       - ci
       - run-soapui-tests
     steps:
-      - uses: step-security/harden-runner@17d0e2bd7d51742c71671bd19fa12bdc9d40a3d6 # v2.8.1
+      - uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0
         with:
           egress-policy: audit
 
@@ -163,7 +163,7 @@ jobs:
           GH_TOKEN: ${{ secrets.WEAREFRANK_BOT_PAT }}
 
   docker-release:
-    uses: wearefrank/ci-cd-templates/.github/workflows/docker-release-generic.yml@e8affe3c6b9d1a725b3332042f82096286974d15 #1.0.2
+    uses: wearefrank/ci-cd-templates/.github/workflows/docker-release-generic.yml@5ec30763e8d8eeed008edcac3c6a329367e42760 #1.0.4
     needs: 
     - analyze-commits
     - release
@@ -193,4 +193,4 @@ jobs:
       - release
     # Set to true to enable Docusaurus publishing to GitHub Pages
     if: true
-    uses: wearefrank/ci-cd-templates/.github/workflows/docusaurus-release.yml@e8affe3c6b9d1a725b3332042f82096286974d15 #1.0.2
+    uses: wearefrank/ci-cd-templates/.github/workflows/docusaurus-release.yml@5ec30763e8d8eeed008edcac3c6a329367e42760 #1.0.4
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,38 @@
 [![conventional commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![semantic versioning](https://img.shields.io/badge/semantic%20versioning-2.0.0-green.svg)](https://semver.org)
 
+## [1.20.2](https://github.com/wearefrank/zaakbrug/compare/v1.20.1...v1.20.2) (2024-07-26)
+
+### 🤖 Build System
+
+* **dependencies:** bump the github-actions group with 2 updates ([#426](https://github.com/wearefrank/zaakbrug/issues/426)) ([5e2df91](https://github.com/wearefrank/zaakbrug/commit/5e2df91ebf68b259f3d7f03ce993d7c3aafb66f3))
+
+### 🔁 Continuous Integration
+
+* use waf bot pat token for bump-ff-version workflow due to permission issue with ci checks in the created pr ([1794919](https://github.com/wearefrank/zaakbrug/commit/17949192cc76e2613161e4267e02779428be3fd0))
+
+## [1.20.1](https://github.com/wearefrank/zaakbrug/compare/v1.20.0...v1.20.1) (2024-07-19)
+
+### 🔁 Continuous Integration
+
+* automatically bump the Frank!Framework version on a weekly basis ([#301](https://github.com/wearefrank/zaakbrug/issues/301)) ([bad76bd](https://github.com/wearefrank/zaakbrug/commit/bad76bd7d5b238a73059181864cdb46eaa4904c1))
+
+## [1.20.0](https://github.com/wearefrank/zaakbrug/compare/v1.19.16...v1.20.0) (2024-07-17)
+
+### 🍕 Features
+
+* new case closing behavior that skips an endstatus in actualiseerZaakStatus so that a following updateZaak can close the case by setting the enddate ([#424](https://github.com/wearefrank/zaakbrug/issues/424)) ([1110d72](https://github.com/wearefrank/zaakbrug/commit/1110d72efd1f5c2c8c880042dadb314479625c9b))
+
+## [1.19.16](https://github.com/wearefrank/zaakbrug/compare/v1.19.15...v1.19.16) (2024-07-16)
+
+### 🐛 Bug Fixes
+
+* defaultProfile not being used when there is no zaaktype specific translation profile configured ([#402](https://github.com/wearefrank/zaakbrug/issues/402)) ([179c468](https://github.com/wearefrank/zaakbrug/commit/179c468b3f8b77e065e06c36a98ed1204281fbc0))
+* updateZaak incorrectly distinguishes roles due to 'authentiek' dataloss in translation resulting in attempt to add as new role ([#418](https://github.com/wearefrank/zaakbrug/issues/418)) ([266d9ca](https://github.com/wearefrank/zaakbrug/commit/266d9ca47483353291dd1653699f55343c1279a4))
+
+### 🤖 Build System
+
+* **dependencies:** bump the github-actions group across 1 directory with 3 updates ([#422](https://github.com/wearefrank/zaakbrug/issues/422)) ([77ed198](https://github.com/wearefrank/zaakbrug/commit/77ed198e34ef9bca04a7606cca8f74926f575747))
+
 ## [1.19.15](https://github.com/wearefrank/zaakbrug/compare/v1.19.14...v1.19.15) (2024-07-10)
 
 ### 🐛 Bug Fixes

diff --git a/README.md b/README.md
@@ -51,23 +51,98 @@ The syntax for variable substitution is as follows {[variable-name][:formatting-
 
 ## Translation Profiles
 
-### Closing zaak
+### Closing zaak with updateZaak message
 Closing a zaak' refers to the action of setting the EindStatus (Last Status) to the zaak itself. EindStatus refers to a status created with a Status Type where the 'isEindStatus' field is set to true. When a zaak has such EindStatus then it means the zaak is closed.
 To be able to close a zaak, the zaak must have a Resultaat(Result) value as well. In case the zaak doesn't have a Resultaat value, then one of the dummy values in Profile.json file (if exists) will be used as explained below.
 
 There are three ways of closing a zaak.
 
 1) Setting EindDatum (End Date)
 When EindDatum field is set in updateZaak message and if the zaak already has a Resultaat then EindStatus (Last Status) is automatically set to the zaak so the zaak is closed.
-However, if the zaak doesn't have a Resultaat when EindDatum field is set, then a Resultaat with the dummy value under 'endCaseEndDate' in Profile.json file is set to zaak. After that, EindStatus is automatically set to the zaak so the zaak is closed. 'endCaseEndDate' should be under the 'zaakTypeIdentificatie' which is the Zaaktype of the zaak.
+However, if the zaak doesn't have a Resultaat when EindDatum field is set, then a Resultaat with the dummy value under 'endCaseEndDate' in Profile.json file (translation profile) is set to zaak. After that, EindStatus is automatically set to the zaak so the zaak is closed. 'endCaseEndDate' property should be at the same level of the 'zaakTypeIdentificatie' property which is the Zaaktype of the zaak in the profile so that it could be fetched by using the 'zaakTypeIdentificatie' from Profile.json file.
 
 2) Setting EindStatus(LastStatus)
 There is no specifically EindStatus field in updateZaak (or any other) message. However, the fields under 'Heeft' element in updateZaak message are used to create an EindStatus. When an updateZaak message is sent and if the 'Heeft' element has the required fields and if the zaak has a Resultaat, then EindStatus is created and set to the Zaak so the zaak is closed. 
-In case the zaak doesn't have a Resultaat, the dummy value under 'endDateAndResultLastStatus' in Profile.json file is used to create one. 'endDateAndResultLastStatus' should be under the 'zaakTypeIdentificatie' which is the Zaaktype of the zaak.
+In case the zaak doesn't have a Resultaat, the dummy value under 'endDateAndResultLastStatus' in Profile.json file is used to create one. 'endDateAndResultLastStatus' property should be at the same level of the 'zaakTypeIdentificatie' property which is the Zaaktype of the zaak in the profile so that it could be fetched by using the 'zaakTypeIdentificatie' from Profile.json file.
 
 3) Setting both EindDatum (End Date) and EindStatus(Last Status)
 In case of having both EindDatum and EindStatus(meaning having required fields under 'Heeft' element) in updateZaak message, first EindStatus path is used to close a zaak. If Zaak doesn't have a Resultaat and if there is no dummy value under 'endDateAndResultLastStatus' in Profile.json then EindDatum path is used to close the zaak.
 
+### Closing zaak with actualiseerZaakStatus message (Configurable)
+A zaak can also be closed with actualiseerZaakStatus message with eindStatus in it unless the `ignoreEindStatusInActualiseerZaakStatus` property is set true in profiles.json file (translation profile).
+
+As default the property is falsy so a zaak can be close by actualiseerZaakStatus. If ignoring the eindStatus in actualiseerZaakStatus message is wanted, then add the property `ignoreEindStatusInActualiseerZaakStatus` with value "true" into the `profileDefaults` section in profiles.json file. Then zaak closure with actualiseerZaakStatus message will not be allowed for any zaaktype.
+
+It is also possible to add `ignoreEindStatusInActualiseerZaakStatus` property to a specific zaaktype as well if different behaviour is desired.
+
+If a zaaktype is not listed in profiles or the profile of a specific zaaktype doesn't have the `ignoreEindStatusInActualiseerZaakStatus` property, then always the one in `profileDefaults` section is used. If `ignoreEindStatusInActualiseerZaakStatus` is not set at all in any section of profile.json file, then it will be counted as false so zaak closure with actualiseerZaakStatus message will be allowed.
+
+Example configuration:
+```json
+{
+    "profileDefaults": {
+        "ignoreEindStatusInActualiseerZaakStatus": "true"
+    },
+    "profile": [
+        {
+            "zaakTypeIdentificatie": "B9999",
+            "endCaseEndDate": {
+                "coalesceResultaat": "Onbekend"
+            },
+            "endDateAndResultLastStatus": {
+                "coalesceResultaat": "Onbekend"
+            }
+        },
+        {
+            "zaakTypeIdentificatie": "B1210",
+            "ignoreEindStatusInActualiseerZaakStatus": "false",
+            "endDateAndResultLastStatus": {
+                "coalesceResultaat":"Vergunningvrij" 
+            }
+        },
+        {
+            "zaakTypeIdentificatie": "B1026",
+            "endCaseEndDate": {
+                "coalesceResultaat": "Toegekend"
+            }
+        }
+    ]
+}
+```
+
+Will result in:
+```json
+{
+    "profile": [
+        {
+            "zaakTypeIdentificatie": "B9999",
+            "ignoreEindStatusInActualiseerZaakStatus": "true",
+            "endCaseEndDate": {
+                "coalesceResultaat": "Onbekend"
+            },
+            "endDateAndResultLastStatus": {
+                "coalesceResultaat": "Onbekend"
+            }
+        },
+        {
+            "zaakTypeIdentificatie": "B1210",
+            "ignoreEindStatusInActualiseerZaakStatus": "false",
+            "endDateAndResultLastStatus": {
+                "coalesceResultaat":"Vergunningvrij" 
+            }
+        },
+        {
+            "zaakTypeIdentificatie": "B1026",
+            "ignoreEindStatusInActualiseerZaakStatus": "true",
+            "endCaseEndDate": {
+                "coalesceResultaat": "Toegekend"
+            }
+        }
+    ]
+}
+```
+
+
 ### Profile Defaults
 Profile defaults can be used to configure common translation profile settings. The settings configured in the `profileDefaults` section are applied to **all** zaaktypen. When a regular translation profile for a specific zaaktype is also configured, the settings are merged together. The more specific per zaaktype translation profile will always override any overlapping settings from the `profileDefaults` section. Items in array's like `valuesOverrides` will be combined instead, unless there is an overlapping key. Here the more specific per zaaktype translation profile will also always override any overlapping keys from the ones in the `profileDefaults` section.
 
@@ -191,4 +266,4 @@ Currently this feature implemented for:
 1. Navigate to "docusaurus" subfolder with `cd ./docusaurus`.
 2. Install dependencies with `npm install`.
 3. Serve Docusaurus webserver locally with `docusaurus start`. By default it is served at `http://localhost:3000/`.
-4. Basic guide on how to use Docusaurus and a styleguide can be found at `./docusaurus/docs/_README.md`.
+4. Basic guide on how to use Docusaurus and a styleguide can be found at `./docusaurus/docs/_README.md`.