From 91434f550a94918de48bd51e8033e3cacf72a997 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 09:59:07 +0200 Subject: [PATCH 01/19] Create build_swagger.yml Job to build swagger documentation --- .github/workflows/build_swagger.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/workflows/build_swagger.yml diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml new file mode 100644 index 0000000000..2cb31f1fa0 --- /dev/null +++ b/.github/workflows/build_swagger.yml @@ -0,0 +1,23 @@ +name: build Swagger documentation + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + runs-on: ubuntu-latest + defaults: + run: + working-directory: docs/swagger + steps: + - uses: actions/checkout@v4 + - name: run service + run: mvn spring-boot:run + - name: check service is running + run: curl http://localhost:8080 + - name: get swagger.js + run: curl http://localhost:8080/v3/api-docs + From 295a05727b5fe30e9441fac113db1be4b219c934 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 10:05:39 +0200 Subject: [PATCH 02/19] move to alarm-logger directory --- .github/workflows/build_swagger.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index 2cb31f1fa0..30893ce2aa 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -14,6 +14,10 @@ jobs: working-directory: docs/swagger steps: - uses: actions/checkout@v4 + - name: cd + run: cd services/alarm-logger + - name: pwd + run: pwd - name: run service run: mvn spring-boot:run - name: check service is running From e804155470617f7f0025479f44a4ff436dba439b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 10:59:50 +0200 Subject: [PATCH 03/19] can run on develop branch --- .github/workflows/build_swagger.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index 30893ce2aa..253b833667 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -2,9 +2,9 @@ name: build Swagger documentation on: push: - branches: [ "main" ] + branches: [ "main", "develop" ] pull_request: - branches: [ "main" ] + branches: [ "main", "develop" ] jobs: build: From 5d569a465426c67d9e30ed777b3e72061c48f7f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 11:02:30 +0200 Subject: [PATCH 04/19] changed working directory --- .github/workflows/build_swagger.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index 253b833667..c6818883fc 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -11,11 +11,9 @@ jobs: runs-on: ubuntu-latest defaults: run: - working-directory: docs/swagger + working-directory: services/alarm-logger steps: - uses: actions/checkout@v4 - - name: cd - run: cd services/alarm-logger - name: pwd run: pwd - name: run service From c7988a449fb6130ca7e3444e8aadcd57fca89d32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 11:19:51 +0200 Subject: [PATCH 05/19] running background --- .github/workflows/build_swagger.yml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index c6818883fc..709a45ce70 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -16,10 +16,16 @@ jobs: - uses: actions/checkout@v4 - name: pwd run: pwd - - name: run service - run: mvn spring-boot:run + - name: run alarm logger service + run: mvn spring-boot:run & + - name: get alarm logger ID + run: jobpid="$!" + - name: wait + run: sleep 120 - name: check service is running run: curl http://localhost:8080 - name: get swagger.js run: curl http://localhost:8080/v3/api-docs + - name: kill alarm logger + run: kill "$jobpid" From f1e5c900699c2f836ef1cc192585b0477b77eb83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 11:24:27 +0200 Subject: [PATCH 06/19] Update build_swagger.yml --- .github/workflows/build_swagger.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index 709a45ce70..3da1b37b3b 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -17,15 +17,15 @@ jobs: - name: pwd run: pwd - name: run alarm logger service - run: mvn spring-boot:run & - - name: get alarm logger ID - run: jobpid="$!" + run: mvn spring-boot:run + #- name: get alarm logger ID + # run: jobpid="$!" - name: wait run: sleep 120 - name: check service is running run: curl http://localhost:8080 - name: get swagger.js run: curl http://localhost:8080/v3/api-docs - - name: kill alarm logger - run: kill "$jobpid" + #- name: kill alarm logger + # run: kill "$jobpid" From 32f98220fc372949c29cd49110aef293de5f1a14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 11:31:23 +0200 Subject: [PATCH 07/19] Update build_swagger.yml --- .github/workflows/build_swagger.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index 3da1b37b3b..119e1e0750 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -11,9 +11,13 @@ jobs: runs-on: ubuntu-latest defaults: run: - working-directory: services/alarm-logger + working-directory: . steps: - uses: actions/checkout@v4 + - name: dependencies + run: mvn clean verify -Djavafx.platform=linux -f dependencies/pom.xml + - name: cd + run: cd services/alarm-logger - name: pwd run: pwd - name: run alarm logger service From 479b55edb6619cdc1b91d0deacabd2d1e97ab215 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 11:39:09 +0200 Subject: [PATCH 08/19] setup maven --- .github/workflows/build_swagger.yml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index 119e1e0750..c08325ebbd 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -9,13 +9,15 @@ on: jobs: build: runs-on: ubuntu-latest - defaults: - run: - working-directory: . steps: - uses: actions/checkout@v4 - - name: dependencies - run: mvn clean verify -Djavafx.platform=linux -f dependencies/pom.xml + - name: Setup Maven and Java Action + uses: s4u/setup-maven-action@v1.13.0 + with: + java-version: '17' + maven-version: '3.9.6' + - name: Build + run: mvn --batch-mode install -DskipTests - name: cd run: cd services/alarm-logger - name: pwd From 2f2a9453a9c94f18a1b4ec682f12b8fee1f8e636 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 13:03:52 +0200 Subject: [PATCH 09/19] Update build_swagger.yml --- .github/workflows/build_swagger.yml | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index c08325ebbd..bbf420447b 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -16,14 +16,16 @@ jobs: with: java-version: '17' maven-version: '3.9.6' - - name: Build - run: mvn --batch-mode install -DskipTests - - name: cd - run: cd services/alarm-logger + #- name: Build + # run: mvn --batch-mode install -DskipTests + #- name: cd + # run: cd services/alarm-logger - name: pwd run: pwd - - name: run alarm logger service - run: mvn spring-boot:run + - name: ls + run: ls + #- name: run alarm logger service + # run: mvn spring-boot:run #- name: get alarm logger ID # run: jobpid="$!" - name: wait From faab80f19ad4f05085a188de2c3825110b3299dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 13:06:57 +0200 Subject: [PATCH 10/19] Update build_swagger.yml --- .github/workflows/build_swagger.yml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index bbf420447b..729023c199 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -18,8 +18,12 @@ jobs: maven-version: '3.9.6' #- name: Build # run: mvn --batch-mode install -DskipTests - #- name: cd - # run: cd services/alarm-logger + - name: pwd + run: pwd + - name: ls + run: ls + - name: cd + run: cd ./services/alarm-logger - name: pwd run: pwd - name: ls @@ -28,8 +32,8 @@ jobs: # run: mvn spring-boot:run #- name: get alarm logger ID # run: jobpid="$!" - - name: wait - run: sleep 120 + #- name: wait + # run: sleep 120 - name: check service is running run: curl http://localhost:8080 - name: get swagger.js From d6b62b971603b55403fcbbfbd805ac8447dd2bda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 13:13:15 +0200 Subject: [PATCH 11/19] Update build_swagger.yml --- .github/workflows/build_swagger.yml | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index 729023c199..0b951327fb 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -18,12 +18,10 @@ jobs: maven-version: '3.9.6' #- name: Build # run: mvn --batch-mode install -DskipTests - - name: pwd - run: pwd - - name: ls - run: ls - name: cd - run: cd ./services/alarm-logger + run: | + cd ./services/alarm-logger + pwd - name: pwd run: pwd - name: ls From 48a9e4d3e8d3b8f5fa8b46c3b0cce3881962cce9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 16:24:31 +0200 Subject: [PATCH 12/19] Update build_swagger.yml --- .github/workflows/build_swagger.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index 0b951327fb..cfeda8fb4b 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -22,6 +22,7 @@ jobs: run: | cd ./services/alarm-logger pwd + mvn spring-boot:run - name: pwd run: pwd - name: ls From 978bd08fb438441857532adc9a6f05f9937953bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 16:28:20 +0200 Subject: [PATCH 13/19] Update build_swagger.yml --- .github/workflows/build_swagger.yml | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index cfeda8fb4b..6b7a57254d 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -18,25 +18,18 @@ jobs: maven-version: '3.9.6' #- name: Build # run: mvn --batch-mode install -DskipTests - - name: cd + - name: run alarm logger service run: | cd ./services/alarm-logger pwd - mvn spring-boot:run - - name: pwd - run: pwd - - name: ls - run: ls - #- name: run alarm logger service - # run: mvn spring-boot:run - #- name: get alarm logger ID - # run: jobpid="$!" - #- name: wait - # run: sleep 120 + mvn spring-boot:run & + jobpid="$!" + - name: wait + run: sleep 30 - name: check service is running run: curl http://localhost:8080 - name: get swagger.js run: curl http://localhost:8080/v3/api-docs - #- name: kill alarm logger - # run: kill "$jobpid" + - name: kill alarm logger + run: kill "$jobpid" From 3e9b16dff6a19d53ca747edd4366ce03eb84064d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Tue, 27 Aug 2024 16:34:47 +0200 Subject: [PATCH 14/19] Update build_swagger.yml --- .github/workflows/build_swagger.yml | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index 6b7a57254d..955a06bab1 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -18,18 +18,13 @@ jobs: maven-version: '3.9.6' #- name: Build # run: mvn --batch-mode install -DskipTests - - name: run alarm logger service + - name: Get swagger.json run: | cd ./services/alarm-logger pwd mvn spring-boot:run & - jobpid="$!" - - name: wait - run: sleep 30 - - name: check service is running - run: curl http://localhost:8080 - - name: get swagger.js - run: curl http://localhost:8080/v3/api-docs - - name: kill alarm logger - run: kill "$jobpid" - + export jobpid="$!" + sleep 30 + curl http://localhost:8080 + curl http://localhost:8080/v3/api-docs + kill "$jobpid" From 8fa8de88e7776838cd5fb662227a52177f458747 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Wed, 28 Aug 2024 14:33:30 +0200 Subject: [PATCH 15/19] add json to md conversion --- .github/workflows/build_swagger.yml | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index 955a06bab1..ce33b565b2 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -21,10 +21,27 @@ jobs: - name: Get swagger.json run: | cd ./services/alarm-logger - pwd mvn spring-boot:run & export jobpid="$!" sleep 30 curl http://localhost:8080 - curl http://localhost:8080/v3/api-docs + curl http://localhost:8080/v3/api-docs --output ../../docs/swagger/swagger.json kill "$jobpid" + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: '20.x' + - name: Install dependencies + run: | + cd docs/swagger + npm install + - name: Run converter + run: | + cd docs/swagger + node convertMarkDown.js + ls + - name: Archive swagger.md + uses: actions/upload-artifact@v4 + with: + name: markdown + path: docs/swagger/swagger.md From 8daf0a7c2cb1f05e5536962214fe6f86a2337991 Mon Sep 17 00:00:00 2001 From: lcaouen Date: Wed, 28 Aug 2024 14:41:07 +0200 Subject: [PATCH 16/19] add md converter --- docs/swagger/convertMarkDown.js | 18 ++++++++++++++++++ docs/swagger/package.json | 14 ++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 docs/swagger/convertMarkDown.js create mode 100644 docs/swagger/package.json diff --git a/docs/swagger/convertMarkDown.js b/docs/swagger/convertMarkDown.js new file mode 100644 index 0000000000..183df98c7f --- /dev/null +++ b/docs/swagger/convertMarkDown.js @@ -0,0 +1,18 @@ +const widdershins = require('widdershins'); +const fs = require('fs'); + +const options = { + language_tabs: [{ python: "Python" }, { ruby: "Ruby" }] +}; + +const fileData = fs.readFileSync('api-docs.json', 'utf8'); +const swaggerFile = JSON.parse(fileData); + +widdershins.convert(swaggerFile, options) + .then(markdownOutput => { + // markdownOutput contains the converted markdown + fs.writeFileSync('out/swagger.md', markdownOutput, 'utf8'); + }) + .catch(err => { + // handle errors + }); diff --git a/docs/swagger/package.json b/docs/swagger/package.json new file mode 100644 index 0000000000..a47ce4d17c --- /dev/null +++ b/docs/swagger/package.json @@ -0,0 +1,14 @@ +{ + "name": "swaggerconverter", + "version": "1.0.0", + "description": "", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "dependencies": { + "widdershins": "^4.0.1" + } +} From 10252e4829bd4827cc8c238a3a00baba99886cdd Mon Sep 17 00:00:00 2001 From: lcaouen Date: Wed, 28 Aug 2024 14:47:44 +0200 Subject: [PATCH 17/19] changed json and md filenames --- docs/swagger/convertMarkDown.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/swagger/convertMarkDown.js b/docs/swagger/convertMarkDown.js index 183df98c7f..16988ab1f9 100644 --- a/docs/swagger/convertMarkDown.js +++ b/docs/swagger/convertMarkDown.js @@ -5,13 +5,13 @@ const options = { language_tabs: [{ python: "Python" }, { ruby: "Ruby" }] }; -const fileData = fs.readFileSync('api-docs.json', 'utf8'); +const fileData = fs.readFileSync('swagger.json', 'utf8'); const swaggerFile = JSON.parse(fileData); widdershins.convert(swaggerFile, options) .then(markdownOutput => { // markdownOutput contains the converted markdown - fs.writeFileSync('out/swagger.md', markdownOutput, 'utf8'); + fs.writeFileSync('swagger.md', markdownOutput, 'utf8'); }) .catch(err => { // handle errors From 448b6568876b42c21d7905a97628feb7e5c7d67e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc?= Date: Wed, 28 Aug 2024 15:21:55 +0200 Subject: [PATCH 18/19] upload swagger.json as an artifact --- .github/workflows/build_swagger.yml | 24 ++++-------------------- 1 file changed, 4 insertions(+), 20 deletions(-) diff --git a/.github/workflows/build_swagger.yml b/.github/workflows/build_swagger.yml index ce33b565b2..9093c1caf6 100644 --- a/.github/workflows/build_swagger.yml +++ b/.github/workflows/build_swagger.yml @@ -16,32 +16,16 @@ jobs: with: java-version: '17' maven-version: '3.9.6' - #- name: Build - # run: mvn --batch-mode install -DskipTests - name: Get swagger.json run: | cd ./services/alarm-logger mvn spring-boot:run & export jobpid="$!" sleep 30 - curl http://localhost:8080 - curl http://localhost:8080/v3/api-docs --output ../../docs/swagger/swagger.json + curl http://localhost:8080/v3/api-docs --output ../../docs/swagger.json kill "$jobpid" - - name: Use Node.js - uses: actions/setup-node@v4 - with: - node-version: '20.x' - - name: Install dependencies - run: | - cd docs/swagger - npm install - - name: Run converter - run: | - cd docs/swagger - node convertMarkDown.js - ls - - name: Archive swagger.md + - name: Archive swagger.json uses: actions/upload-artifact@v4 with: - name: markdown - path: docs/swagger/swagger.md + name: swagger.json + path: docs/swagger.json From 392de1644dd1c3ba3a6476411966886cc93c440c Mon Sep 17 00:00:00 2001 From: lcaouen Date: Wed, 28 Aug 2024 15:33:18 +0200 Subject: [PATCH 19/19] Remove markdown conversion. Conversion can be made by read the docs directly with sphinx https://sphinxcontrib-openapi.readthedocs.io/ https://sphinxcontrib-redoc.readthedocs.io/en/stable/ --- docs/swagger/convertMarkDown.js | 18 ------------------ docs/swagger/package.json | 14 -------------- 2 files changed, 32 deletions(-) delete mode 100644 docs/swagger/convertMarkDown.js delete mode 100644 docs/swagger/package.json diff --git a/docs/swagger/convertMarkDown.js b/docs/swagger/convertMarkDown.js deleted file mode 100644 index 16988ab1f9..0000000000 --- a/docs/swagger/convertMarkDown.js +++ /dev/null @@ -1,18 +0,0 @@ -const widdershins = require('widdershins'); -const fs = require('fs'); - -const options = { - language_tabs: [{ python: "Python" }, { ruby: "Ruby" }] -}; - -const fileData = fs.readFileSync('swagger.json', 'utf8'); -const swaggerFile = JSON.parse(fileData); - -widdershins.convert(swaggerFile, options) - .then(markdownOutput => { - // markdownOutput contains the converted markdown - fs.writeFileSync('swagger.md', markdownOutput, 'utf8'); - }) - .catch(err => { - // handle errors - }); diff --git a/docs/swagger/package.json b/docs/swagger/package.json deleted file mode 100644 index a47ce4d17c..0000000000 --- a/docs/swagger/package.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "name": "swaggerconverter", - "version": "1.0.0", - "description": "", - "main": "index.js", - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, - "author": "", - "license": "ISC", - "dependencies": { - "widdershins": "^4.0.1" - } -}