Merge pull request #245 from BilelJegham/master

Github Action
CouscousPHP · Apr 25, 2020 · 458509f · 458509f
2 parents 7dde0e0 + 7e76e0f
commit 458509f
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/couscous.yml b/couscous.yml
@@ -33,6 +33,9 @@ menu:
         travis:
             text: Travis integration
             relativeUrl: docs/travis.html
+        action:
+            text: Github Action integration
+            relativeUrl: docs/githubaction.html
         faq:
             text: FAQ
             relativeUrl: docs/faq.html

diff --git a/docs/README.md b/docs/README.md
@@ -9,6 +9,7 @@ This is the documentation root. Here are some articles to help you:
 - [Configuration using `couscous.yml`](configuration.md)
 - [Writing templates](templates.md)
 - [Metadata](metadata.md)
+- [Automatic deployment using Github Action](githubaction.md)
 - [Automatic deployment using Travis CI](travis.md)
 - [FAQ](faq.md)
 - [Contributing](../CONTRIBUTING.md)
diff --git a/docs/githubaction.md b/docs/githubaction.md
@@ -0,0 +1,29 @@
+---
+current_menu: action
+---
+# Automatic deployment using GithubAction
+
+You want to use add Couscous in your workflow Github (https://github.com/marketplace/actions/couscous-generate).
+
+## Create Workflow in `.github/workflows/***.yml`
+```yml
+name: Couscous GithubPage
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: CouscousPHP/GitHub-Action@v1
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./.couscous/generated
+```