From 35c947bd44302e71fe68c740186f77f1b4703584 Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Sat, 5 Mar 2022 09:44:24 +0100 Subject: [PATCH 01/10] Mobile Client: Documentation deployment workflow --- .github/workflows/documentation.yaml | 64 ++++++++++++++-------------- 1 file changed, 31 insertions(+), 33 deletions(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 73aa948..ac2308e 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -3,49 +3,47 @@ on: push: branches: - master - - workflows + - dev + workflow_dispatch: + jobs: - DeployBackDocumentation: - runs-on: ubuntu-20.04 + DeployDocumentation: + name: "Generate ${{ matrix.run_name }}'s documentation" + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + include: + - project_dir: mobile + run_name: 'Mobile client' + doc_dir: 'doc/api' + use: 'subosito/flutter-action@v1.5.3' + warm_up: flutter pub global activate dartdoc; rm -rf doc + doc_generation: dartdoc + defaults: + run: + working-directory: ${{ matrix.project_dir }} steps: - uses: actions/checkout@v2.3.4 - - name: Install stack - run: curl -sSL https://get.haskellstack.org/ | sh -s - -f - - name: Generate Haddock documentation - run: stack haddock --haddock-arguments --odir="docs" + - uses: subosito/flutter-action@v2.2.0 + with: + channel: 'dev' + if: matrix.project_dir == 'mobile' + - name: Warmup + run: ${{ matrix.warm_up }} ; ls -l + - name: Generate documentation + run: ${{ matrix.doc_generation }} - name: Deploy run: | - cd docs + cd "${{ matrix.doc_dir }}" git config --global user.email "${GITHUB_ACTOR}@github.com"; git config --global user.name "${GITHUB_ACTOR}"; git init git add -A; - git commit -m "Deploying the back-end's documentation"; + git commit -m "Deploying the ${{ matrix.run_name }}'s documentation"; git remote add origin https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@${GITHUB_REPO}; - git checkout -b documentation-back - git push --force origin documentation-back; - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - GITHUB_REPO: "github.com/AnonymusRaccoon/Aeris" - DeployMobileAppDocumentation: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2.3.4 - - uses: subosito/flutter-action@v1.5.3 - - name: Update Documentation - run: | - flutter pub global activate dartdoc - rm -rf doc - dartdoc - cd doc/api - git config --global user.email "${GITHUB_ACTOR}@github.com"; - git config --global user.name "${GITHUB_ACTOR}"; - git init - git add -A; - git commit -m "Deploying the mobile client documentation"; - git remote add origin https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@${GITHUB_REPO}; - git checkout -b documentation-mobile - git push --force origin documentation-mobile; + git checkout -b documentation-${{ matrix.project_dir }} + git push --force origin documentation-${{ matrix.project_dir }}; env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_REPO: "github.com/AnonymusRaccoon/Aeris" \ No newline at end of file From 824a446cb52c18bbb3de804fec1a65d7ab9f938c Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Sat, 5 Mar 2022 09:46:16 +0100 Subject: [PATCH 02/10] Mobile Client: documentation workflow: remove non-existant branch trigger --- .github/workflows/documentation.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index ac2308e..d326c84 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -3,7 +3,6 @@ on: push: branches: - master - - dev workflow_dispatch: jobs: From 210aeab3c44e2d7e853c8ad50b2e14cfec81e476 Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Sat, 5 Mar 2022 09:47:57 +0100 Subject: [PATCH 03/10] Mobile Client: documentation workflow: add branch trigger glob --- .github/workflows/documentation.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index d326c84..08376e0 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -3,6 +3,7 @@ on: push: branches: - master + - mobile_client* workflow_dispatch: jobs: From 0224b6b316d3831bc6e7b2d4739857a73a1b46a9 Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Sat, 5 Mar 2022 09:49:08 +0100 Subject: [PATCH 04/10] Mobile Client: documentation workflow: add branch trigger glob --- .github/workflows/documentation.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 08376e0..ea2f0ea 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -5,7 +5,6 @@ on: - master - mobile_client* workflow_dispatch: - jobs: DeployDocumentation: name: "Generate ${{ matrix.run_name }}'s documentation" From 3ecd9772197e2ce3a9a274385c0a61b5fed46631 Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Sat, 5 Mar 2022 10:10:26 +0100 Subject: [PATCH 05/10] Mobile Client Documentation: update aeris.dart + gen translations on doc gen --- mobile/lib/aeris.dart | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/mobile/lib/aeris.dart b/mobile/lib/aeris.dart index 757aa3e..a1ba65b 100644 --- a/mobile/lib/aeris.dart +++ b/mobile/lib/aeris.dart @@ -1,8 +1,45 @@ library aeris; export 'package:aeris/src/views/startup_page.dart'; - export 'package:aeris/src/widgets/overlayed_texts.dart'; - export 'package:aeris/src/widgets/background/anim_painter.dart'; export 'package:aeris/src/widgets/background/custom_animation.dart'; +export "package:aeris/src/aeris_api.dart"; +export "package:aeris/src/providers/action_catalogue_provider.dart"; +export "package:aeris/src/providers/pipelines_provider.dart"; +export "package:aeris/src/providers/services_provider.dart"; +export "package:aeris/src/models/pipeline.dart"; +export "package:aeris/src/models/action_template.dart"; +export "package:aeris/src/models/action_parameter.dart"; +export "package:aeris/src/models/reaction.dart"; +export "package:aeris/src/models/trigger.dart"; +export "package:aeris/src/models/service.dart"; +export "package:aeris/src/models/action.dart"; +export "package:aeris/src/models/pipeline_collection.dart"; +export "package:aeris/src/constants.dart"; +export "package:aeris/src/views/pipeline_detail_page.dart"; +export "package:aeris/src/views/authorization_page.dart"; +export "package:aeris/src/views/setup_action_page.dart"; +export "package:aeris/src/views/service_page.dart"; +export "package:aeris/src/views/login_page.dart"; +export "package:aeris/src/views/home_page.dart"; +export "package:aeris/src/views/create_pipeline_page.dart"; +export "package:aeris/src/views/startup_page.dart"; +export "package:aeris/src/widgets/background/anim_painter.dart"; +export "package:aeris/src/widgets/background/custom_animation.dart"; +export "package:aeris/src/widgets/background/animated_background.dart"; +export "package:aeris/src/widgets/action_card_popup_menu.dart"; +export "package:aeris/src/widgets/reorderable_reaction_cards_list.dart"; +export "package:aeris/src/widgets/aeris_page.dart"; +export "package:aeris/src/widgets/aeris_popup_menu_item.dart"; +export "package:aeris/src/widgets/warning_dialog.dart"; +export "package:aeris/src/widgets/home_page_sort_menu.dart"; +export "package:aeris/src/widgets/aeris_popup_menu.dart"; +export "package:aeris/src/widgets/aeris_card_page.dart"; +export "package:aeris/src/widgets/colored_clickable_card.dart"; +export "package:aeris/src/widgets/action_form.dart"; +export "package:aeris/src/widgets/overlayed_texts.dart"; +export "package:aeris/src/widgets/clickable_card.dart"; +export "package:aeris/src/widgets/pipeline_card.dart"; +export "package:aeris/src/widgets/action_card.dart"; +export "package:aeris/src/widgets/setup_api_route.dart"; From 61f0b2c16a9f06f5f31779780103ce20a1e881b9 Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Sat, 5 Mar 2022 10:11:02 +0100 Subject: [PATCH 06/10] Mobile Client Documentation: update aeris.dart + gen translations on doc gen --- .github/workflows/documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index ea2f0ea..a1070b5 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -17,7 +17,7 @@ jobs: run_name: 'Mobile client' doc_dir: 'doc/api' use: 'subosito/flutter-action@v1.5.3' - warm_up: flutter pub global activate dartdoc; rm -rf doc + warm_up: flutter pub global activate dartdoc; rm -rf doc ; flutter gen-l10n doc_generation: dartdoc defaults: run: From b880029d3d7a5406512bf6a3b1c52f387e6a66e9 Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Sat, 5 Mar 2022 10:15:27 +0100 Subject: [PATCH 07/10] Mobile Client Documentation: update aeris.dart + gen translations on doc gen --- .github/workflows/documentation.yaml | 1 - mobile/lib/aeris.dart | 4 ---- 2 files changed, 5 deletions(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index a1070b5..5b01e3c 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -3,7 +3,6 @@ on: push: branches: - master - - mobile_client* workflow_dispatch: jobs: DeployDocumentation: diff --git a/mobile/lib/aeris.dart b/mobile/lib/aeris.dart index a1ba65b..ea91568 100644 --- a/mobile/lib/aeris.dart +++ b/mobile/lib/aeris.dart @@ -1,9 +1,5 @@ library aeris; -export 'package:aeris/src/views/startup_page.dart'; -export 'package:aeris/src/widgets/overlayed_texts.dart'; -export 'package:aeris/src/widgets/background/anim_painter.dart'; -export 'package:aeris/src/widgets/background/custom_animation.dart'; export "package:aeris/src/aeris_api.dart"; export "package:aeris/src/providers/action_catalogue_provider.dart"; export "package:aeris/src/providers/pipelines_provider.dart"; From ae06865e8277c95f6bf90a7639706bd09a4af402 Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Sat, 5 Mar 2022 10:15:54 +0100 Subject: [PATCH 08/10] Mobile Client Documentation: update aeris.dart + gen translations on doc gen --- .github/workflows/documentation.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 5b01e3c..a1070b5 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -3,6 +3,7 @@ on: push: branches: - master + - mobile_client* workflow_dispatch: jobs: DeployDocumentation: From 2fcf8942235836ea9e3e16011a46358901dedc50 Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Sat, 5 Mar 2022 10:24:26 +0100 Subject: [PATCH 09/10] Mobile Client Documentation: update aeris.dart + gen translations on doc gen --- .github/workflows/documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index a1070b5..1a337d6 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -18,7 +18,7 @@ jobs: doc_dir: 'doc/api' use: 'subosito/flutter-action@v1.5.3' warm_up: flutter pub global activate dartdoc; rm -rf doc ; flutter gen-l10n - doc_generation: dartdoc + doc_generation: dartdoc; defaults: run: working-directory: ${{ matrix.project_dir }} From 7799831ffc7026bbae493d0b3629264b44c596b7 Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Sun, 6 Mar 2022 03:06:58 +0100 Subject: [PATCH 10/10] Mobile Client: doc --- mobile/lib/aeris.dart | 78 +++++++++++++++++++++---------------------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/mobile/lib/aeris.dart b/mobile/lib/aeris.dart index ea91568..10be6dd 100644 --- a/mobile/lib/aeris.dart +++ b/mobile/lib/aeris.dart @@ -1,41 +1,41 @@ library aeris; -export "package:aeris/src/aeris_api.dart"; -export "package:aeris/src/providers/action_catalogue_provider.dart"; -export "package:aeris/src/providers/pipelines_provider.dart"; -export "package:aeris/src/providers/services_provider.dart"; -export "package:aeris/src/models/pipeline.dart"; -export "package:aeris/src/models/action_template.dart"; -export "package:aeris/src/models/action_parameter.dart"; -export "package:aeris/src/models/reaction.dart"; -export "package:aeris/src/models/trigger.dart"; -export "package:aeris/src/models/service.dart"; -export "package:aeris/src/models/action.dart"; -export "package:aeris/src/models/pipeline_collection.dart"; -export "package:aeris/src/constants.dart"; -export "package:aeris/src/views/pipeline_detail_page.dart"; -export "package:aeris/src/views/authorization_page.dart"; -export "package:aeris/src/views/setup_action_page.dart"; -export "package:aeris/src/views/service_page.dart"; -export "package:aeris/src/views/login_page.dart"; -export "package:aeris/src/views/home_page.dart"; -export "package:aeris/src/views/create_pipeline_page.dart"; -export "package:aeris/src/views/startup_page.dart"; -export "package:aeris/src/widgets/background/anim_painter.dart"; -export "package:aeris/src/widgets/background/custom_animation.dart"; -export "package:aeris/src/widgets/background/animated_background.dart"; -export "package:aeris/src/widgets/action_card_popup_menu.dart"; -export "package:aeris/src/widgets/reorderable_reaction_cards_list.dart"; -export "package:aeris/src/widgets/aeris_page.dart"; -export "package:aeris/src/widgets/aeris_popup_menu_item.dart"; -export "package:aeris/src/widgets/warning_dialog.dart"; -export "package:aeris/src/widgets/home_page_sort_menu.dart"; -export "package:aeris/src/widgets/aeris_popup_menu.dart"; -export "package:aeris/src/widgets/aeris_card_page.dart"; -export "package:aeris/src/widgets/colored_clickable_card.dart"; -export "package:aeris/src/widgets/action_form.dart"; -export "package:aeris/src/widgets/overlayed_texts.dart"; -export "package:aeris/src/widgets/clickable_card.dart"; -export "package:aeris/src/widgets/pipeline_card.dart"; -export "package:aeris/src/widgets/action_card.dart"; -export "package:aeris/src/widgets/setup_api_route.dart"; +export "src/aeris_api.dart"; +export "src/providers/action_catalogue_provider.dart"; +export "src/providers/pipelines_provider.dart"; +export "src/providers/services_provider.dart"; +export "src/models/pipeline.dart"; +export "src/models/action_template.dart"; +export "src/models/action_parameter.dart"; +export "src/models/reaction.dart"; +export "src/models/trigger.dart"; +export "src/models/service.dart"; +export "src/models/action.dart"; +export "src/models/pipeline_collection.dart"; +export "src/constants.dart"; +export "src/views/pipeline_detail_page.dart"; +export "src/views/authorization_page.dart"; +export "src/views/setup_action_page.dart"; +export "src/views/service_page.dart"; +export "src/views/login_page.dart"; +export "src/views/home_page.dart"; +export "src/views/create_pipeline_page.dart"; +export "src/views/startup_page.dart"; +export "src/widgets/background/anim_painter.dart"; +export "src/widgets/background/custom_animation.dart"; +export "src/widgets/background/animated_background.dart"; +export "src/widgets/action_card_popup_menu.dart"; +export "src/widgets/reorderable_reaction_cards_list.dart"; +export "src/widgets/aeris_page.dart"; +export "src/widgets/aeris_popup_menu_item.dart"; +export "src/widgets/warning_dialog.dart"; +export "src/widgets/home_page_sort_menu.dart"; +export "src/widgets/aeris_popup_menu.dart"; +export "src/widgets/aeris_card_page.dart"; +export "src/widgets/colored_clickable_card.dart"; +export "src/widgets/action_form.dart"; +export "src/widgets/overlayed_texts.dart"; +export "src/widgets/clickable_card.dart"; +export "src/widgets/pipeline_card.dart"; +export "src/widgets/action_card.dart"; +export "src/widgets/setup_api_route.dart";