feat: Improve documentation deploy. (#1007)

* feature: Improve documentation deploy.

* minimal changes.

.github/workflows/docs.yml

@@ -2,17 +2,18 @@
 # For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
 # This file was contributed by Carlos Parada and Yamel Senih from ERP Consultores y Asociados, C.A
 
-name: Build Project
+name: Deploy on Github Pages
 
 # Controls when the action will run. 
 on:
   push:
-    branches: [ master, develop ]
+    branches: 
-  release:
+      # Push events on master and develop branchs
-    types: [created]
+      - master
-
+      - develop
-  # Allows you to run this workflow manually from the Actions tab
+    # takes only the directory changes
-  workflow_dispatch:
+    paths:
+      - 'docs/**'
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
@@ -20,33 +21,39 @@ jobs:
   build:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
+
     strategy:
       matrix:
         node-version: [14.x]
+
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       - uses: actions/checkout@v2
+
       - uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
-      - run: set -e
+
-      - run: |
+      - name: Generate static vuepress files
-             cd docs
+        run: |
-             npm i
+          cd docs
-             npm run build
+          npm i
-      - run: |
+          npm run build
-            cd docs
+
-            git clone https://github.com/adempiere/adempiere-vue.git --branch gh-pages --single-branch gh-pages
+      - name: Init new repo in dist folder and commit generated files
-            cp -r .vuepress/dist/* gh-pages/
+        run: |
-            cd gh-pages
+          cd docs/.vuepress/dist
-            touch .nojekyll 
+          touch .nojekyll
-            git init 
+          git init
-            git config --local user.email "action@github.com"
+          git config --local user.email "action@github.com"
-            git config --local user.name "GitHub Action"
+          git config --local user.name "GitHub Action"
-            git add .
+          git add -A
-            git commit -m "Update documentation" -a || true
+          git commit -m "docs: ${{ github.event.head_commit.message }}" -a || true
-      - uses: ad-m/github-push-action@master
+
+      - name: Force push to destination branch
+        uses: ad-m/github-push-action@v0.6.0
         with:
           branch: gh-pages
-          directory: docs/gh-pages
+          force: true
+          directory: docs/.vuepress/dist
           github_token: ${{ secrets.GITHUB_TOKEN }}

docs/README.md

@@ -20,12 +20,19 @@ features:
 footer: GNU/GPL v3 Licensed | Copyright © 2019-present ADempiere
 ---
 
+<p align="center">
+  <img width="320" src="https://upload.wikimedia.org/wikipedia/commons/b/b1/Adempiere-logo.png">
+</p>
+
 ## Getting Started
 
 ```bash
 # clone the project
 git clone https://github.com/adempiere/adempiere-vue.git
 
+# be located on the path
+cd adempiere-vue/docs/
+
 # install dependency
 yarn install
 
@@ -33,6 +40,8 @@ yarn install
 yarn dev
 ```
 
-## Demo
+## Live Preview
 
 [ADempiere UI Demo](https://demo-ui.erpya.com/)
+
+[ADempiere UI Documentation](https://adempiere.github.io/adempiere-vue/)