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

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: "Continuous Integration"
+name: Continuous Integration
 
 on:
   pull_request:
@@ -109,5 +109,3 @@ jobs:
         with:
           name: reports-soapui-testreports
           path: ./*/reports
-
-

.github/workflows/release.yml

@@ -36,8 +36,8 @@ jobs:
         id: next-version
         run: semantic-release --dryRun
         env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.WEAREFRANK_BOT_PAT }}
+          GH_TOKEN: ${{ secrets.WEAREFRANK_BOT_PAT }}
 
   ci:
     uses: wearefrank/ci-cd-templates/.github/workflows/ci-generic.yml@main
@@ -134,21 +134,21 @@ jobs:
       - name: Checkout
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 #4.1.1
         with:
-          token: ${{ secrets.GH_TOKEN }}
+          token: ${{ secrets.WEAREFRANK_BOT_PAT }}
 
-      - name: "Download Pre-build Artifacts"
+      - name: Download Pre-build Artifacts
         uses: actions/download-artifact@eaceaf801fd36c7dee90939fad912460b18a1ffe #4.1.2
         with:
           pattern: pre-build-*
           merge-multiple: true
 
-      - name: "Download Build Artifacts"
+      - name: Download Build Artifacts
         uses: actions/download-artifact@eaceaf801fd36c7dee90939fad912460b18a1ffe #4.1.2
         with:
           pattern: build-*
           merge-multiple: true
 
-      - name: "Setup Node"
+      - name: Setup Node
         uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 #4.0.2
         with:
           node-version: 20
@@ -159,8 +159,8 @@ jobs:
       - name: Semantic Release
         run: semantic-release
         env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.WEAREFRANK_BOT_PAT }}
+          GH_TOKEN: ${{ secrets.WEAREFRANK_BOT_PAT }}
 
   docker-release:
     uses: wearefrank/ci-cd-templates/.github/workflows/docker-release-generic.yml@main
@@ -173,15 +173,24 @@ jobs:
       dockerhub-token: ${{ secrets.DOCKERHUB_TOKEN }}
     with:
       version: ${{ needs.analyze-commits.outputs.version-next }}
-      docker-image-repo: ${{ vars.DOCKER_IMAGE_REPOSITORY }}
-      docker-image-name: ${{ vars.DOCKER_IMAGE_NAME }}
 
   update-helm:
     uses: ./.github/workflows/update-helm-chart.yml
     needs: 
       - release
       - analyze-commits
     secrets:
-      token: ${{ secrets.GH_TOKEN }}
+      token: ${{ secrets.WEAREFRANK_BOT_PAT }}
     with:
       version: ${{ needs.analyze-commits.outputs.version-next }}
+
+  docusaurus-release:
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    needs: 
+      - release
+    # Set to true to enable Docusaurus publishing to GitHub Pages
+    if: true
+    uses: wearefrank/ci-cd-templates/.github/workflows/docusaurus-release.yml@main

.gitignore

@@ -2,3 +2,8 @@ Test.properties
 /.idea/
 /target/
 /data/
+*.iml
+
+
+# .env should be made in the environment.
+# It is an additional file to StageSpecifics_LOC to keep it more generic.

.releaserc

@@ -1,5 +1,5 @@
 {
-  "branches": ["master", "1.0.x"],
+  "branches": ["master", "main", "1.0.x"],
   "debug": "true",
   "plugins": [
     [
@@ -12,7 +12,7 @@
           {"type": "fix", "release": "patch"},
           {"type": "perf", "release": "patch"},
           {"type": "revert", "release": "patch"},
-          {"type": "docs", "release": "minor"},
+          {"type": "docs", "release": "patch"},
           {"type": "style", "release": "patch"},
           {"type": "refactor", "release": "patch"},
           {"type": "test", "release": "patch"},
@@ -76,9 +76,9 @@
       "@semantic-release/git",
       {
         "assets": [
+          "CHANGELOG.md",
           "src/main/resources/BuildInfo.properties",
           "classes/BuildInfo.properties",
-          "CHANGELOG.md",
           "./charts/zaakbrug/Chart.yaml"
         ],
         "message": "chore(<%= nextRelease.type %>): release <%= nextRelease.version %> <%= nextRelease.channel !== null ? `on ${nextRelease.channel} channel ` : '' %>[skip ci]\n\n<%= nextRelease.notes %>"

CHANGELOG.md

@@ -1,5 +1,71 @@
 [![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.19.12](https://github.com/wearefrank/zaakbrug/compare/v1.19.11...v1.19.12) (2024-06-27)
+
+### 🐛 Bug Fixes
+
+* adding heeftBetrekkingOp in an updateZaak action throws error ([b5e8572](https://github.com/wearefrank/zaakbrug/commit/b5e85727b38dc1c24e8b4053ae566f88396f4764))
+
+### ✅ Tests
+
+* add testcases for heeftBetrekkingOp with and without address ([4eff2ca](https://github.com/wearefrank/zaakbrug/commit/4eff2ca88132e2de3fdf603a63e605b943780938))
+
+## [1.19.11](https://github.com/wearefrank/zaakbrug/compare/v1.19.10...v1.19.11) (2024-06-25)
+
+### 🤖 Build System
+
+* **dependencies:** bump docusaurus version to 2.4.0 ([bb5ac6b](https://github.com/wearefrank/zaakbrug/commit/bb5ac6b9d528ecc375baa48bb7700f7de2992951))
+
+## [1.19.10](https://github.com/wearefrank/zaakbrug/compare/v1.19.9...v1.19.10) (2024-06-25)
+
+### 🧑‍💻 Code Refactoring
+
+* replace authorization custom code with standard ff pipes ([#393](https://github.com/wearefrank/zaakbrug/issues/393)) ([1d6671b](https://github.com/wearefrank/zaakbrug/commit/1d6671b11481d69c4694bd0ff8dc4009dd859957))
+
+## [1.19.9](https://github.com/wearefrank/zaakbrug/compare/v1.19.8...v1.19.9) (2024-06-25)
+
+### 🐛 Bug Fixes
+
+* geefLijstZaakdocumenten should not return an error response when the zaak can't be found ([#395](https://github.com/wearefrank/zaakbrug/issues/395)) ([d4ce003](https://github.com/wearefrank/zaakbrug/commit/d4ce0037296ca861dfed89df99680fcab7a5633a))
+
+## [1.19.8](https://github.com/wearefrank/zaakbrug/compare/v1.19.7...v1.19.8) (2024-06-21)
+
+### 🐛 Bug Fixes
+
+* document status is not being translated from zgw to zds ([#355](https://github.com/wearefrank/zaakbrug/issues/355)) ([8b06c39](https://github.com/wearefrank/zaakbrug/commit/8b06c39881758c1a404d169282dfcc32b75c80c1))
+
+## [1.19.7](https://github.com/wearefrank/zaakbrug/compare/v1.19.6...v1.19.7) (2024-06-21)
+
+### 🐛 Bug Fixes
+
+* authentiek element is not taken into account when identifying a gerelateerde on a role during updateZaak ([70be86d](https://github.com/wearefrank/zaakbrug/commit/70be86dee915beee5efe9e7b4ff93a27868efe68))
+* updateZaak fails when deleting a gerelateerde and in the same updateZaak add a new gerelateerde on the same roltype ([7b532b9](https://github.com/wearefrank/zaakbrug/commit/7b532b903fcbf8a748fff6b819bbc98de0118878))
+* updateZaak not able to handle multiple gerelateerde for a single roltype ([a9d6607](https://github.com/wearefrank/zaakbrug/commit/a9d6607eb4dd2fdbd42ba20a8a0be2106ff59b71))
+* updateZaak sometimes incorrectly detects changes to case roles resulting in unnecessary delete and post calls ([8825c6c](https://github.com/wearefrank/zaakbrug/commit/8825c6c48ea951ee3682a367123e4adf195ed8e4))
+
+### 🧑‍💻 Code Refactoring
+
+* updateZaak uses verwerkingsoort when processing case roles ([4bb2da2](https://github.com/wearefrank/zaakbrug/commit/4bb2da29177f9be4ec3b1f55f9dbaac1cf0662af))
+* verwerkingssoort 'I' on case roles are processed as 'T' if the role is not present on the case ([#285](https://github.com/wearefrank/zaakbrug/issues/285)) ([1ec7016](https://github.com/wearefrank/zaakbrug/commit/1ec701606c0f0bb3c82d593745f3110f33b2c9c7))
+
+### ✅ Tests
+
+* add assertions to check for regression on various geefLijstZaakdocumenten and geefZaakDetails steps [skip ci] ([3b2bfbf](https://github.com/wearefrank/zaakbrug/commit/3b2bfbf540c36b5c2f606cb7e07cd9012bbe4c57))
+* add testcases for all different combinations of verwerkingsoort on case roles ([f88f0a6](https://github.com/wearefrank/zaakbrug/commit/f88f0a6a299c5a760ad037c3b46faf9f63a81efd))
+* add testcases for deleting, changing and adding multiple gerelateerde on a single roltype ([e7b68a1](https://github.com/wearefrank/zaakbrug/commit/e7b68a1119d9ba2fc4ea75343302f1d88dd3b7f2))
+
+## [1.19.6](https://github.com/wearefrank/zaakbrug/compare/v1.19.5...v1.19.6) (2024-06-11)
+
+### 📝 Documentation
+
+* replace broken link how-to-set-or-override-properties with placeholder ([396715e](https://github.com/wearefrank/zaakbrug/commit/396715ed738a5a3eb85951ea2a47bf5797adc5b0))
+
+## [1.19.5](https://github.com/wearefrank/zaakbrug/compare/v1.19.4...v1.19.5) (2024-06-11)
+
+### 📝 Documentation
+
+* introduce docusaurus documentation website hosted as github pages ([4a784b3](https://github.com/wearefrank/zaakbrug/commit/4a784b3cddd10151b78548da734ffe7f5032e585))
+
 ## [1.19.4](https://github.com/wearefrank/zaakbrug/compare/v1.19.3...v1.19.4) (2024-06-04)
 
 ### 🐛 Bug Fixes

CONTRIBUTING.md

@@ -11,9 +11,20 @@ Execute the following steps when bumping the Frank!Framework version:
 4. Replace the default value for `FF_VERSION` under `services.zaakbrug.build.args` in `docker-compose.zaakbrug.dev.yml` with the new tag. NOTE: Watch out to not replace the '-' in front of the tag: ${FF_VERSION:-<new tag>}
 5. Replace the value of `ff.version` in `frank-runner.properties` with the new tag.
 6. Start ZaakBrug with the `Frank!Runner` to automatically replace the `./src/main/configuration/<configuration-name>/FrankConfig.xsd` and `./src/main/configuration/FrankConfig.xsd` with the newer version. You can stop the Frank!Runner once the files are replaced. Note that currently the Frank!Runner will also add `FrankConfig.xsd` to the `.gitignore` file. Make sure to revert the change to `.gitignore`.
-7. Check [GitHub - Frank!Framework - Parameter.java commit history](https://github.com/frankframework/frankframework/commits/master/core/src/main/java/org/frankframework/parameters/Parameter.java) for any changes to this class. The latest version of the source code of Parameter.java can be reached directly from master branch from [Github - Frank!Framework - Parameter.java source code](https://github.com/frankframework/frankframework/blob/master/core/src/main/java/org/frankframework/parameters/Parameter.java). If there are indeed changes, update the corresponding file under `./src/main/java/org/frankframework/...`. The `.java-orig` file content should be 1 on 1 equal to the new version on GitHub. Take care to not accidentally remove the intended customization of the code in the `.java` file.
-8. Run the e2e testsuite by using the below Docker-Compose and configuration to validate the changes. You should only need `docker-compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.openzaak.dev.yml up --build --force-recreate` for this. (TODO: Automate running of e2e tests in ci/cd).
-9. Commit you changes on a branch with as message: `build(dependencies): bump f!f version to <new tag>`. Create a PR to have you changes merged to master.
+7. Run the e2e testsuite by using the below Docker-Compose and configuration to validate the changes. You should only need `docker-compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.openzaak.dev.yml up --build --force-recreate` for this. (TODO: Automate running of e2e tests in ci/cd).
+8. Commit you changes on a branch with as message: `build(dependencies): bump f!f version to <new tag>`. Create a PR to have your changes merged to master.
+
+## Docusaurus version
+1. Navigate to "docusaurus" subfolder with `cd ./docusaurus`.
+1. Update dependencies with `npm i @docusaurus/core@latest @docusaurus/preset-classic@latest @docusaurus/module-type-aliases@latest @docusaurus/tsconfig@latest @docusaurus/types@latest`.
+1. Commit you changes on a branch with as message: `build(dependencies): bump docusaurus version to <new tag>`. Create a PR to have your changes merged to master.
+
+# Local Development
+## Docusaurus
+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`.
 
 # Testing with SoapUI
 

Dockerfile

@@ -7,6 +7,8 @@ FROM docker.io/frankframework/frankframework:${FF_VERSION} as ff-base
 COPY --chown=tomcat lib/server/* /usr/local/tomcat/lib/
 COPY --chown=tomcat lib/webapp/* /usr/local/tomcat/webapps/ROOT/WEB-INF/lib/
 
+# # Compile custom class
+# FROM eclipse-temurin:17-jdk-jammy AS custom-code-builder
 
 # Compile custom class
 FROM eclipse-temurin:17-jdk-jammy AS custom-code-builder
@@ -19,14 +21,12 @@ COPY --from=ff-base /usr/local/tomcat/webapps/ROOT /usr/local/tomcat/webapps/ROO
 COPY src/main/java /tmp/java
 RUN mkdir /tmp/classes && \
     javac \
-    /tmp/java/org/frankframework/parameters/Parameter.java \
     /tmp/java/org/frankframework/http/HttpSenderCached.java \
     /tmp/java/org/frankframework/http/HttpSenderBaseCached.java \
     -classpath "/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/*:/usr/local/tomcat/lib/*" \
     -verbose -d /tmp/classes
 
-
-FROM ff-base
+# FROM ff-base
 
 # Copy custom entrypoint script with added options
 COPY --chown=tomcat docker/entrypoint.sh /scripts/entrypoint.sh
@@ -47,8 +47,8 @@ COPY --chown=tomcat src/main/configurations/ /opt/frank/configurations/
 COPY --chown=tomcat src/main/resources/ /opt/frank/resources/
 COPY --chown=tomcat src/test/testtool/ /opt/frank/testtool/
 
-# Copy compiled custom class
-COPY --from=custom-code-builder --chown=tomcat /tmp/classes/ /usr/local/tomcat/webapps/ROOT/WEB-INF/classes
+# # Copy compiled custom class
+# COPY --from=custom-code-builder --chown=tomcat /tmp/classes/ /usr/local/tomcat/webapps/ROOT/WEB-INF/classes
 
 # Check if Frank! is still healthy
 HEALTHCHECK --interval=15s --timeout=5s --start-period=30s --retries=60 \

README.md

@@ -186,3 +186,9 @@ A value override is only applied if the property's value after the translation f
 
 Currently this feature implemented for:
 - (zaken-api) zaak
+
+## Local Development Docusaurus
+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`.

docusaurus/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docusaurus/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docusaurus/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};