Setup CI/CD

jshmrtn · Mar 30, 2020 · 7e5d482 · 7e5d482
1 parent 1814262
commit 7e5d482
Show file tree

Hide file tree

Showing 12 changed files with 418 additions and 8 deletions.
diff --git a/.github/workflows/elixir.yml b/.github/workflows/elixir.yml
@@ -0,0 +1,370 @@
+on:
+  - push
+  - pull_request
+
+env:
+  BUILD_EMBEDDED: true
+  DIALYZER_PLT_PRIV: true
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  deps:
+    name: Install Deps
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: textbook/git-checkout-submodule-action@master
+      - uses: actions/setup-elixir@v1
+        with:
+          otp-version: 22.2
+          elixir-version: 1.10.2
+      - uses: actions/cache@v1
+        id: cache
+        with:
+          path: deps
+          key: deps-${{ runner.os }}-${{ github.ref }}
+          restore-keys: |
+            deps-${{ runner.os }}-
+            deps-
+      - run: mix deps.get
+      - uses: actions/upload-artifact@master
+        with:
+          name: deps
+          path: deps
+      - uses: actions/upload-artifact@master
+        with:
+          name: deps_lock
+          path: mix.lock
+
+  compile_dev:
+    name: Compile Dev Environment
+
+    runs-on: ubuntu-latest
+
+    needs: ['deps']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: textbook/git-checkout-submodule-action@master
+      - uses: actions/setup-elixir@v1
+        with:
+          otp-version: 22.2
+          elixir-version: 1.10.2
+      - uses: actions/download-artifact@master
+        with:
+          name: deps
+          path: deps
+      - uses: actions/download-artifact@master
+        with:
+          name: deps_lock
+          path: .
+      - uses: actions/cache@v1
+        id: cache
+        with:
+          path: _build/dev
+          key: compile_dev-${{ runner.os }}-${{ github.ref }}
+          restore-keys: |
+            compile_dev-${{ runner.os }}-
+            compile_dev-
+      - run: mix deps.compile
+        env:
+          MIX_ENV: dev
+      - run: mix compile --warning-as-errors
+        env:
+          MIX_ENV: dev
+      - uses: actions/upload-artifact@master
+        with:
+          name: compile_dev
+          path: _build/dev
+
+  compile_test:
+    name: Compile Test Environment (OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}})
+
+    runs-on: ubuntu-latest
+
+    needs: ['deps']
+
+    strategy:
+      fail-fast: false
+      matrix:
+        otp: [21.3, 22.2]
+        elixir: [1.9.4, 1.10.2]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: textbook/git-checkout-submodule-action@master
+      - uses: actions/setup-elixir@v1
+        with:
+          otp-version: ${{matrix.otp}}
+          elixir-version: ${{matrix.elixir}}
+      - uses: actions/download-artifact@master
+        with:
+          name: deps
+          path: deps
+      - uses: actions/download-artifact@master
+        with:
+          name: deps_lock
+          path: .
+      - uses: actions/cache@v1
+        id: cache
+        with:
+          path: _build/test
+          key: compile_test-${{matrix.otp}}-${{matrix.elixir}}-${{ runner.os }}-${{ github.ref }}
+          restore-keys: |
+            compile_test-${{matrix.otp}}-${{matrix.elixir}}-${{ runner.os }}-
+            compile_test-${{matrix.otp}}-${{matrix.elixir}}-
+      - run: mix deps.compile
+        env:
+          MIX_ENV: test
+      - run: mix compile --warning-as-errors
+        env:
+          MIX_ENV: test
+      - uses: actions/upload-artifact@master
+        with:
+          name: compile_test-${{matrix.otp}}-${{matrix.elixir}}
+          path: _build/test
+
+  compile_prod:
+    name: Compile Prod Environment
+
+    runs-on: ubuntu-latest
+
+    needs: ['deps']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: textbook/git-checkout-submodule-action@master
+      - uses: actions/setup-elixir@v1
+        with:
+          otp-version: 22.2
+          elixir-version: 1.10.2
+      - uses: actions/download-artifact@master
+        with:
+          name: deps
+          path: deps
+      - uses: actions/download-artifact@master
+        with:
+          name: deps_lock
+          path: .
+      - uses: actions/cache@v1
+        id: cache
+        with:
+          path: _build/prod
+          key: compile_prod-${{ runner.os }}-${{ github.ref }}
+          restore-keys: |
+            compile_prod-${{ runner.os }}-
+            compile_prod-
+      - run: mix deps.compile
+        env:
+          MIX_ENV: prod
+      - run: mix compile --warning-as-errors
+        env:
+          MIX_ENV: prod
+      - uses: actions/upload-artifact@master
+        with:
+          name: compile_prod
+          path: _build/prod
+
+  format:
+    name: Check Formatting
+
+    runs-on: ubuntu-latest
+
+    needs: ['deps']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: textbook/git-checkout-submodule-action@master
+      - uses: actions/setup-elixir@v1
+        with:
+          otp-version: 22.2
+          elixir-version: 1.10.2
+      - uses: actions/download-artifact@master
+        with:
+          name: deps
+          path: deps
+      - uses: actions/download-artifact@master
+        with:
+          name: deps_lock
+          path: .
+      - run: mix format --check-formatted
+        env:
+          MIX_ENV: dev
+
+  test:
+    name: Run Tests & Submit Coverage (OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}})
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        otp: [21.3, 22.2]
+        elixir: [1.9.4, 1.10.2]
+
+    needs: ['deps', 'compile_test']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: textbook/git-checkout-submodule-action@master
+      - uses: actions/setup-elixir@v1
+        with:
+          otp-version: ${{matrix.otp}}
+          elixir-version: ${{matrix.elixir}}
+      - uses: actions/download-artifact@master
+        with:
+          name: deps
+          path: deps
+      - uses: actions/download-artifact@master
+        with:
+          name: deps_lock
+          path: .
+      - uses: actions/download-artifact@master
+        with:
+          name: compile_test-${{matrix.otp}}-${{matrix.elixir}}
+          path: _build/test
+      - run: mix coveralls.github
+        env:
+          MIX_ENV: test
+
+  credo:
+    name: Check Credo
+
+    runs-on: ubuntu-latest
+
+    needs: ['deps', 'compile_dev']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: textbook/git-checkout-submodule-action@master
+      - uses: actions/setup-elixir@v1
+        with:
+          otp-version: 22.2
+          elixir-version: 1.10.2
+      - uses: actions/download-artifact@master
+        with:
+          name: deps
+          path: deps
+      - uses: actions/download-artifact@master
+        with:
+          name: deps_lock
+          path: .
+      - uses: actions/download-artifact@master
+        with:
+          name: compile_dev
+          path: _build/dev
+      - run: mix credo --strict
+        env:
+          MIX_ENV: dev
+
+  dialyzer_plt:
+    name: Generate Dialyzer PLT
+
+    runs-on: ubuntu-latest
+
+    needs: ['deps', 'compile_dev']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: textbook/git-checkout-submodule-action@master
+      - uses: actions/setup-elixir@v1
+        with:
+          otp-version: 22.2
+          elixir-version: 1.10.2
+      - uses: actions/download-artifact@master
+        with:
+          name: deps
+          path: deps
+      - uses: actions/download-artifact@master
+        with:
+          name: deps_lock
+          path: .
+      - uses: actions/download-artifact@master
+        with:
+          name: compile_dev
+          path: _build/dev
+      - uses: actions/cache@v1
+        id: cache
+        with:
+          path: priv/plts/
+          key: dialyzer_plt_dev-${{ runner.os }}-${{ github.ref }}
+          restore-keys: |
+            dialyzer_plt_dev-${{ runner.os }}-
+            dialyzer_plt_dev-
+      - run: mix dialyzer --plt
+        env:
+          MIX_ENV: dev
+      - uses: actions/upload-artifact@master
+        with:
+          name: dialyzer_plt_dev
+          path: priv/plts/
+
+  dialyzer_test:
+    name: "Check Dialyzer"
+
+    runs-on: ubuntu-latest
+
+    needs: ['deps', 'compile_dev', 'dialyzer_plt']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: textbook/git-checkout-submodule-action@master
+      - uses: actions/setup-elixir@v1
+        with:
+          otp-version: 22.2
+          elixir-version: 1.10.2
+      - uses: actions/download-artifact@master
+        with:
+          name: deps
+          path: deps
+      - uses: actions/download-artifact@master
+        with:
+          name: deps_lock
+          path: .
+      - uses: actions/download-artifact@master
+        with:
+          name: compile_dev
+          path: _build/dev
+      - uses: actions/download-artifact@master
+        with:
+          name: dialyzer_plt_dev
+          path: priv/plts/
+      - run: mix dialyzer --halt-exit-status
+        env:
+          MIX_ENV: dev
+
+  docs:
+    name: "Generate Docs"
+
+    runs-on: ubuntu-latest
+
+    needs: ['deps', 'compile_dev']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: textbook/git-checkout-submodule-action@master
+      - uses: actions/setup-elixir@v1
+        with:
+          otp-version: 22.2
+          elixir-version: 1.10.2
+      - uses: actions/download-artifact@master
+        with:
+          name: deps
+          path: deps
+      - uses: actions/download-artifact@master
+        with:
+          name: deps_lock
+          path: .
+      - uses: actions/download-artifact@master
+        with:
+          name: compile_dev
+          path: _build/dev
+      - run: mix docs
+        env:
+          MIX_ENV: dev
+      - uses: actions/upload-artifact@master
+        with:
+          name: docs
+          path: doc
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,6 @@ erl_crash.dump
 # Ignore package tarball (built via "mix hex.build").
 openapi_compiler-*.tar
 
+# CI PLT's
+/priv/plts/*.plt
+/priv/plts/*.plt.hash
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,3 @@
 [submodule "priv/examples/openapi-specification"]
 	path = priv/examples/openapi-specification
-	url = git@github.com:OAI/OpenAPI-Specification.git
+	url = https://github.com/OAI/OpenAPI-Specification.git
diff --git a/README.md b/README.md
@@ -1,5 +1,10 @@
 # OpenAPICompiler
 
+[![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/openapi_compiler)
+![.github/workflows/elixir.yml](https://github.com/jshmrtn/openapi-compiler/workflows/.github/workflows/elixir.yml/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/jshmrtn/openapi-compiler/badge.svg?branch=master)](https://coveralls.io/r/jshmrtn/openapi-compiler?branch=master)
+[![Hex.pm](https://img.shields.io/hexpm/dt/openapi_compiler.svg)](https://hex.pm/packages/openapi_compiler)
+
 :warning: :warning: This library is incomplete and experimental! :warning: :warning:
 
 Compile OpenApi 3.0 Elixir Client from JSON / Yaml.