From 11bf934a1e0f209f655e00ea83edf5a0e70c1b1a Mon Sep 17 00:00:00 2001 From: Thomas Fink <53316058+ThomasAFink@users.noreply.github.com> Date: Fri, 24 Jan 2025 16:14:55 +0100 Subject: [PATCH 1/4] fix(ZMS): Update static.yaml --- .github/workflows/static.yaml | 46 +++++++++++++++-------------------- 1 file changed, 19 insertions(+), 27 deletions(-) diff --git a/.github/workflows/static.yaml b/.github/workflows/static.yaml index 22ce2b1ba..4fb48fe6b 100644 --- a/.github/workflows/static.yaml +++ b/.github/workflows/static.yaml @@ -1,21 +1,16 @@ -# Workflow for deploying zmsapi PHP and Node.js static content to Pages -name: Deploy zmsapi static content to Pages +# Workflow for deploying API documentation to Pages +name: Deploy API Documentation to Pages on: - # Runs on pushes targeting the default branch (main) push: branches: ["main"] - - # Allows you to run this workflow manually from the Actions tab workflow_dispatch: -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages permissions: contents: read pages: write id-token: write -# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. concurrency: group: "pages" cancel-in-progress: false @@ -28,64 +23,61 @@ jobs: runs-on: ubuntu-latest steps: - # Step 1: Checkout the repository - name: Checkout uses: actions/checkout@v4 - # Step 2: Set up PHP environment - name: Set up PHP uses: shivammathur/setup-php@v2 with: - php-version: '8.0' # Specify PHP version as per your requirement + php-version: '8.0' extensions: mbstring, json tools: composer - # Step 3: Install PHP dependencies for zmsapi - name: Install PHP dependencies run: | composer install --working-dir=zmsapi + composer install --working-dir=zmscitizenapi - # Step 4: Run PHP post-install scripts for zmsapi - name: Run PHP post-install scripts run: | cd zmsapi && bin/configure && composer run-script post-install-cmd && cd .. + cd zmscitizenapi && bin/configure && composer run-script post-install-cmd && cd .. - # Step 5: Set up Node.js environment - name: Set up Node.js uses: actions/setup-node@v3 with: - node-version: '16' # Specify Node.js version as needed + node-version: '16' - # Step 6: Install Node.js dependencies for zmsapi - - name: Install Node.js dependencies for zmsapi + - name: Install Node.js dependencies run: | - cd zmsapi - npm install + cd zmsapi && npm install && cd .. + cd zmscitizenapi && npm install && cd .. - # Step 7: Build the project for zmsapi - - name: Build zmsapi + - name: Build projects run: | - cd zmsapi - npm run build + cd zmsapi && npm run build && cd .. + cd zmscitizenapi && npm run build && cd .. - # Step 8: Generate Swagger documentation for zmsapi - name: Generate Swagger documentation run: | cd zmsapi npm run doc npx swagger-cli bundle -o public/doc/swagger.json public/doc/swagger.yaml + cd .. + + cd zmscitizenapi + npm run doc + npx swagger-cli bundle -o public/doc/swagger.json public/doc/swagger.yaml + cd .. - # Step 9: Set up GitHub Pages for deployment - name: Setup Pages uses: actions/configure-pages@v5 - # Step 10: Upload the static content to GitHub Pages - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: - path: '.' # Upload the entire repository, including the generated docs + path: '.' - # Step 11: Deploy to GitHub Pages - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4 From 900bc7e9e3b45d35aee402c4092dd9f9c9e1426f Mon Sep 17 00:00:00 2001 From: Thomas Fink Date: Fri, 24 Jan 2025 16:38:47 +0100 Subject: [PATCH 2/4] fix(ZMS): zmsapi and zmscitizenapi swagger documentation --- zmsapi/composer.json | 1 - zmscitizenapi/checksums.txt | 4 ++++ zmscitizenapi/composer.json | 7 +++++++ 3 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 zmscitizenapi/checksums.txt diff --git a/zmsapi/composer.json b/zmsapi/composer.json index 857d5d1e2..660c319c1 100644 --- a/zmsapi/composer.json +++ b/zmsapi/composer.json @@ -48,7 +48,6 @@ "clean": "rm -f public/doc/assets/*.* && rm -f public/_test/assets/*.*", "command": "bin/configure", "wget-files": [ - "wget https://eappointment.gitlab.io/zmsapi/doc/swagger.json -O public/doc/swagger.json", "wget https://eappointment.gitlab.io/zmsapi/doc/assets/redoc.min.js -O public/doc/assets/redoc.min.js", "wget https://eappointment.gitlab.io/zmsapi/_test/assets/swagger-ui-bundle.js -O public/_test/assets/swagger-ui-bundle.js", "wget https://eappointment.gitlab.io/zmsapi/_test/assets/swagger-ui.css -O public/_test/assets/swagger-ui.css", diff --git a/zmscitizenapi/checksums.txt b/zmscitizenapi/checksums.txt new file mode 100644 index 000000000..a8b6fac1b --- /dev/null +++ b/zmscitizenapi/checksums.txt @@ -0,0 +1,4 @@ +7f700a62cf9c402a09313486b461a06233a4f46ed29d8e38f27f07668fc60591 public/doc/assets/redoc.min.js +73cc9ec630f285bebd75544742055fa89792543ef989e985cbfed217412f6d34 public/_test/assets/swagger-ui-bundle.js +f9e1d39b7fe5b0b472743b42be2b472249feae67c89d63593ce72674c33ca4dd public/_test/assets/swagger-ui.css +68a210d666aa74d72f3001757474a52ba3c5dd03deac11803d2e9ec9c8d6a3c1 public/_test/assets/swagger-ui-standalone-preset.js \ No newline at end of file diff --git a/zmscitizenapi/composer.json b/zmscitizenapi/composer.json index b044bc226..453c0a720 100644 --- a/zmscitizenapi/composer.json +++ b/zmscitizenapi/composer.json @@ -38,6 +38,13 @@ "scripts": { "clean": "rm -f public/doc/assets/*.* && rm -f public/_test/assets/*.*", "command": "bin/configure", + "wget-files": [ + "wget https://eappointment.gitlab.io/zmsapi/doc/assets/redoc.min.js -O public/doc/assets/redoc.min.js", + "wget https://eappointment.gitlab.io/zmsapi/_test/assets/swagger-ui-bundle.js -O public/_test/assets/swagger-ui-bundle.js", + "wget https://eappointment.gitlab.io/zmsapi/_test/assets/swagger-ui.css -O public/_test/assets/swagger-ui.css", + "wget https://eappointment.gitlab.io/zmsapi/_test/assets/swagger-ui-standalone-preset.js -O public/_test/assets/swagger-ui-standalone-preset.js", + "sha256sum --status -c checksums.txt" + ], "post-install-cmd": [ "@wget-files" ], From 290140ae3b5f991f866964225d328b64f5864dc1 Mon Sep 17 00:00:00 2001 From: Thomas Fink Date: Fri, 24 Jan 2025 16:46:35 +0100 Subject: [PATCH 3/4] fix(ZMS): zmsapi and zmscitizenapi swagger documentation add folders --- zmsapi/composer.json | 1 + zmscitizenapi/composer.json | 1 + 2 files changed, 2 insertions(+) diff --git a/zmsapi/composer.json b/zmsapi/composer.json index 660c319c1..1f5a54f1d 100644 --- a/zmsapi/composer.json +++ b/zmsapi/composer.json @@ -47,6 +47,7 @@ "scripts": { "clean": "rm -f public/doc/assets/*.* && rm -f public/_test/assets/*.*", "command": "bin/configure", + "prepare-dirs": "mkdir -p public/_test/assets && mkdir -p public/doc/assets", "wget-files": [ "wget https://eappointment.gitlab.io/zmsapi/doc/assets/redoc.min.js -O public/doc/assets/redoc.min.js", "wget https://eappointment.gitlab.io/zmsapi/_test/assets/swagger-ui-bundle.js -O public/_test/assets/swagger-ui-bundle.js", diff --git a/zmscitizenapi/composer.json b/zmscitizenapi/composer.json index 453c0a720..d533cda86 100644 --- a/zmscitizenapi/composer.json +++ b/zmscitizenapi/composer.json @@ -38,6 +38,7 @@ "scripts": { "clean": "rm -f public/doc/assets/*.* && rm -f public/_test/assets/*.*", "command": "bin/configure", + "prepare-dirs": "mkdir -p public/_test/assets && mkdir -p public/doc/assets", "wget-files": [ "wget https://eappointment.gitlab.io/zmsapi/doc/assets/redoc.min.js -O public/doc/assets/redoc.min.js", "wget https://eappointment.gitlab.io/zmsapi/_test/assets/swagger-ui-bundle.js -O public/_test/assets/swagger-ui-bundle.js", From 202e0e4546707c3289bf5eaa7f36a05637272315 Mon Sep 17 00:00:00 2001 From: Thomas Fink Date: Fri, 24 Jan 2025 16:49:19 +0100 Subject: [PATCH 4/4] fix(ZMS): zmsapi and zmscitizenapi swagger documentation add folders --- zmsapi/composer.json | 2 ++ zmscitizenapi/composer.json | 2 ++ 2 files changed, 4 insertions(+) diff --git a/zmsapi/composer.json b/zmsapi/composer.json index 1f5a54f1d..77bb891ac 100644 --- a/zmsapi/composer.json +++ b/zmsapi/composer.json @@ -56,9 +56,11 @@ "sha256sum --status -c checksums.txt" ], "post-install-cmd": [ + "@prepare-dirs", "@wget-files" ], "post-update-cmd": [ + "@prepare-dirs", "@wget-files" ] }, diff --git a/zmscitizenapi/composer.json b/zmscitizenapi/composer.json index d533cda86..91dad7982 100644 --- a/zmscitizenapi/composer.json +++ b/zmscitizenapi/composer.json @@ -47,9 +47,11 @@ "sha256sum --status -c checksums.txt" ], "post-install-cmd": [ + "@prepare-dirs", "@wget-files" ], "post-update-cmd": [ + "@prepare-dirs", "@wget-files" ] },