DQA-5319: Move documentation into a branch (ec-europa#590)

* DQA-5319: Generate docs. * DQA-5319: Fix ReplaceBlock and add tests. * DQA-5319: Generate docs. * DQA-5319: Documentation. * DQA-5319: DocumentationCommands & tests resources. * DQA-5319: DumpCommands to fail if no dump is found. * DQA-5319: Clean up docs folder. * DQA-5319: Ignore auto-generated files form documentation. * DQA-5319: DocumentationCommand. * DQA-5319: Generate documentation in GitHub actions. * DQA-5319: Debug. * DQA-5319: Change backupFiles. * DQA-5319: Finder sort by name. * DQA-5319: Finder sortByName. * DQA-5319: Finder sortByName true. * DQA-5319: Remove debug. * DQA-5319: Run ci. Co-authored-by: Toolkit <[email protected]>
danistanei · Nov 21, 2022 · 1557427 · 1557427
1 parent 206b04b
commit 1557427
Show file tree

Hide file tree

Showing 111 changed files with 604 additions and 42,294 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,27 @@
+name: 'Release pipeline'
+
+on:
+  workflow_dispatch:
+  workflow_call:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  Documentation:
+    runs-on: ubuntu-latest
+    container: fpfis/httpd-php:8.1-ci
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Validate composer
+        run: composer validate
+
+      - name: Composer
+        run: composer install --prefer-dist --no-ansi --no-interaction
+
+      - name: Generate documentation
+        run: ./vendor/bin/run toolkit:generate-documentation --token=${{ secrets.API_TOKEN }} || echo "skip"
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,11 @@ node_modules/
 .prettierignore
 package.json
 package-lock.json
+/docs_tmp/
+
+# Documentation folder exclusions.
+!docs/
+docs/*
+!docs/guide/
+docs/guide/*
+!docs/guide/*.rst
diff --git a/config/commands/documentation.yml b/config/commands/documentation.yml
@@ -0,0 +1,9 @@
+command:
+  toolkit:
+    generate-documentation:
+      options:
+        token: ${env.GITHUB_API_TOKEN}
+        repo: 'https://%[email protected]/ec-europa/toolkit'
+        docs-dir: docs
+        tmp-dir: docs_tmp
+        branch: documentation
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -17,5 +17,6 @@ services:
       ASDA_USER:
       ASDA_PASSWORD:
       QA_API_BASIC_AUTH:
+      GITHUB_API_TOKEN:
       XDEBUG_CONFIG: remote_host=host.docker.internal remote_port=9003 remote_enable=1
       PHP_IDE_CONFIG: "serverName=Docker"
diff --git a/docs/classes/EcEuropa-Toolkit-Task-Command-ConfigurationCommand.html b/docs/classes/EcEuropa-Toolkit-Task-Command-ConfigurationCommand.html
diff --git a/docs/classes/EcEuropa-Toolkit-Task-Command-Tasks.html b/docs/classes/EcEuropa-Toolkit-Task-Command-Tasks.html