Merge pull request #98 from AnonymusRaccoon/mobile_client_documentation_workflow

Mobile Client: Documentation deployment workflow
This commit is contained in:
Zoe Roux
2022-03-06 19:55:41 +01:00
committed by GitHub
2 changed files with 69 additions and 39 deletions
+30 -33
View File
@@ -3,49 +3,46 @@ on:
push:
branches:
- master
- workflows
- mobile_client*
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 ; flutter gen-l10n
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"
+39 -6
View File
@@ -1,8 +1,41 @@
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 "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";