feat(CI): add documentation workflow

SpaceEEC · Sep 6, 2019 · 6549e8f · 6549e8f
1 parent d87121c
commit 6549e8f
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 16 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,24 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - 'master'
+
+jobs:
+  dispatch:
+    name: Trigger repository dispatch
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Trigger repositorry dispatch
+      env:
+        GITHUB_PAT: ${{ secrets.GITHUB_PAT }}
+      run: |
+        curl -X POST \
+          https://api.github.com/repos/spaceeec/crux/dispatches \
+          -H 'Accept: application/vnd.github.everest-preview+json' \
+          -H "Authorization: token ${GITHUB_PAT}" \
+          -H 'Content-Type: application/json' \
+          -d '{ "event_type": "docs" }'
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -19,12 +19,13 @@ jobs:
 
     steps:
     - uses: actions/checkout@v1
-    - name: Install Dependencies
+    - name: Install dependencies
       run: |
         mix local.rebar --force
         mix local.hex --force
         mix deps.get
-    - name: Tests
+
+    - name: Run tests
       run: mix test
 
   test-elixir-latest:
@@ -37,16 +38,19 @@ jobs:
 
     steps:
     - uses: actions/checkout@v1
-    - name: Install Dependencies
+    - name: Install dependencies
       run: |
         mix local.rebar --force
         mix local.hex --force
         mix deps.get
-    - name: Formatting
+
+    - name: Check formatting
       run: mix format --check-formatted
-    - name: Credo
+
+    - name: Run credo
       run: mix credo --strict
-    - name: Tests
+
+    - name: Test code
       run: mix test
 
   release:
@@ -61,14 +65,16 @@ jobs:
 
     steps:
       - uses: actions/checkout@v1
-      - name: Install Dependencies
+      - name: Install dependencies
         run: |
           mix local.rebar --force
           mix local.hex --force
           mix deps.get
-      - name: Compile
+
+      - name: Compile code
         run: mix compile
-      - name: Publish
+
+      - name: Publish new version
         env:
           HEX_API_KEY: ${{ secrets.HEX_API_KEY }}
         run: mix hex.publish --yes
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -24,12 +24,13 @@ jobs:
 
     steps:
     - uses: actions/checkout@v1
-    - name: Install Dependencies
+    - name: Install dependencies
       run: |
         mix local.rebar --force
         mix local.hex --force
         mix deps.get
-    - name: Tests
+
+    - name: Run tests
       run: mix test
 
   test-elixir-latest:
@@ -42,14 +43,17 @@ jobs:
 
     steps:
     - uses: actions/checkout@v1
-    - name: Install Dependencies
+    - name: Install dependencies
       run: |
         mix local.rebar --force
         mix local.hex --force
         mix deps.get
-    - name: Formatting
+
+    - name: Check formatting
       run: mix format --check-formatted
-    - name: Credo
+
+    - name: Run credo
       run: mix credo --strict
-    - name: Tests
-      run: mix test
+
+    - name: Test code
+      run: mix test