Merge pull request #14 from GPrimola/docs-fix

Docs fix
GPrimola · Feb 15, 2024 · 3dd831e · 3dd831e
2 parents 2b41e3d + b62e81d
commit 3dd831e
Show file tree

Hide file tree

Showing 11 changed files with 247 additions and 140 deletions.
diff --git a/.dialyzer_ignore.exs b/.dialyzer_ignore.exs
@@ -0,0 +1,3 @@
+[
+  {":0:unknown_type Unknown type: YamlElixir.ParsingError.t/0."}
+]
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -2,24 +2,25 @@ name: Yamel CD
 
 on:
   workflow_run:
-    workflows: ["Yamel Master CI"]
+    workflows: ["Yamel Main CI"]
     types:
       - completed
 
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Elixir
-      uses: actions/setup-elixir@v1
+      uses: erlef/setup-beam@v1
       with:
-        elixir-version: '1.8.x'
-        otp-version: '22.3'
+        elixir-version: '1.8.2'
+        otp-version: '22.3.4.26'
+        version-type: 'strict'
     - name: Cache Dependencies
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: |
           _build/prod/lib
@@ -50,18 +51,19 @@ jobs:
       run: mix docs
 
   check_package:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     needs: build
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Elixir
-      uses: actions/setup-elixir@v1
+      uses: erlef/setup-beam@v1
       with:
-        elixir-version: '1.8.x'
-        otp-version: '22.3'
+        elixir-version: '1.8.2'
+        otp-version: '22.3.4.26'
+        version-type: 'strict'
     - name: Cache Dependencies
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: |
           _build/prod/lib
@@ -77,18 +79,19 @@ jobs:
       run: mix hex.publish --dry-run
 
   update_version:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     needs: check_package
 
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Elixir
-        uses: actions/setup-elixir@v1
+        uses: erlef/setup-beam@v1
         with:
-          elixir-version: '1.8.x'
-          otp-version: '22.3'
+          elixir-version: '1.8.2'
+          otp-version: '22.3.4.26'
+          version-type: 'strict'
       - name: Update README.md and mix.exs
         run: |
           elixir ./scripts/update_version.exs
@@ -104,18 +107,19 @@ jobs:
 
 
   publish_package:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     needs: update_version
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Elixir
-      uses: actions/setup-elixir@v1
+      uses: erlef/setup-beam@v1
       with:
-        elixir-version: '1.8.x'
-        otp-version: '22.3'
+        elixir-version: '1.8.2'
+        otp-version: '22.3.4.26'
+        version-type: 'strict'
     - name: Cache Dependencies
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: |
           _build/prod/lib
@@ -128,4 +132,4 @@ jobs:
 
     - env:
         HEX_API_KEY: ${{ secrets.HEX_API_KEY }}
-      run: mix hex.publish --yes
+      run: mix hex.publish --yes
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,23 +1,29 @@
 name: Yamel CI
 
 on:
+  push:
+    branches: [ "main" ]
   pull_request:
-    branches:
-      - master
+    branches: [ "main" ]
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        otp: ['22.3.4.26']
+        elixir: ['1.8.2']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Elixir
-      uses: actions/setup-elixir@v1
+      uses: erlef/setup-beam@v1
       with:
-        elixir-version: '1.8.x'
-        otp-version: '22.3'
+        elixir-version: '1.8.2'
+        otp-version: '22.3.4.26'
+        version-type: 'strict'
     - name: Cache Dependencies
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: |
           deps
@@ -40,18 +46,19 @@ jobs:
       run: mix compile
 
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     needs: build
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Elixir
-      uses: actions/setup-elixir@v1
+      uses: erlef/setup-beam@v1
       with:
-        elixir-version: '1.8.x'
-        otp-version: '22.3'
+        elixir-version: '1.8.2'
+        otp-version: '22.3.4.26'
+        version-type: 'strict'
     - name: Cache Dependencies
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: |
           deps
@@ -65,46 +72,69 @@ jobs:
       run: mix format --check-formatted
 
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     needs: build
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Elixir
-      uses: actions/setup-elixir@v1
+      uses: erlef/setup-beam@v1
       with:
-        elixir-version: '1.8.x'
-        otp-version: '22.3'
+        elixir-version: '1.8.2'
+        otp-version: '22.3.4.26'
+        version-type: 'strict'
     - name: Cache Dependencies
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: |
           deps
           _build/test/lib
         key: ${{ runner.os }}-mix-test-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
         restore-keys: |
           ${{ runner.os }}-mix-test-
-
     - run: mix test
 
+  typecheck:
+    runs-on: ubuntu-20.04
+    needs: build
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Elixir
+      uses: erlef/setup-beam@v1
+      with:
+        elixir-version: '1.8.2'
+        otp-version: '22.3.4.26'
+        version-type: 'strict'
+    - name: Cache Dependencies
+      uses: actions/cache@v3
+      with:
+        path: |
+          deps
+          _build/test/lib
+        key: ${{ runner.os }}-mix-test-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
+        restore-keys: |
+          ${{ runner.os }}-mix-test-
+    - run: mix dialyzer
+
   coverage:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     needs: test
 
     env:
       MIX_ENV: test
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
-      - uses: actions/checkout@v2
-
+      - uses: actions/checkout@v3
       - name: Set up Elixir
-        uses: actions/setup-elixir@v1
+        uses: erlef/setup-beam@v1
         with:
-          elixir-version: '1.9.x'
-          otp-version: '22.3'
+          elixir-version: '1.8.2'
+          otp-version: '22.3.4.26'
+          version-type: 'strict'
 
       - name: Cache Dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             deps