feat: add Node.js VersionManager module & Mix tasks (#1)

sheerlox · Nov 28, 2023 · cc5d14d · cc5d14d
1 parent 83cbe2b
commit cc5d14d
Show file tree

Hide file tree

Showing 18 changed files with 961 additions and 107 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -27,6 +27,7 @@ jobs:
           persist-credentials: false
 
       - name: Set up Elixir
+        id: setup-beam
         uses: erlef/setup-beam@61e01a43a562a89bfc54c7f9a378ff67b03e4a21 # v1.16.0
         with:
           version-type: strict
@@ -35,20 +36,20 @@ jobs:
       - name: Restore dependencies cache
         uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
         env:
-          cache-name: mix-deps
+          cache-key: deps
         with:
-          path: deps
-          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
-          restore-keys: ${{ runner.os }}-${{ env.cache-name }}-
+          key: ${{ env.cache-key }}-${{ runner.os }}-${{ steps.setup-beam.outputs.otp-version }}-${{ steps.setup-beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}-git-${{ github.sha }}
+          restore-keys: |
+            ${{ env.cache-key }}-${{ runner.os }}-${{ steps.setup-beam.outputs.otp-version }}-${{ steps.setup-beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
+            ${{ env.cache-key }}-${{ runner.os }}-${{ steps.setup-beam.outputs.otp-version }}-${{ steps.setup-beam.outputs.elixir-version }}
+          path: |
+            deps
+            _build
 
-      - name: Restore build cache
-        uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
-        env:
-          cache-name: mix-build
-        with:
-          path: _build
-          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
-          restore-keys: ${{ runner.os }}-${{ env.cache-name }}-
+      - name: Install dependencies
+        run: |
+          mix local.hex --force
+          mix do deps.get, deps.compile
 
       - name: Use Node.js LTS
         uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -12,64 +12,130 @@ on:
 permissions:
   contents: read
 
-env:
-  MIX_ENV: test
-
 jobs:
   # ignore the push event trigger if a PR is open for the current branch
-  prevent-duplicate-checks:
+  prevent_duplicate_checks:
     runs-on: ubuntu-latest
     steps:
-      - uses: insurgent-lab/is-in-pr-action@78ecb5daf15aca198aeb2b6f208aabd06b2cb716 # v0.1.4
+      - uses: insurgent-lab/is-in-pr-action@3e01b38aa0d2a0e51bbc84540300303ec850e80d # v0.1.5
         id: isInPR
     outputs:
       should-run: ${{ !(steps.isInPR.outputs.result == 'true' && github.event_name == 'push') }}
 
-  test:
-    name: Build and test
+  test_matrix:
+    name: Test (Elixir ${{matrix.elixir}} | OTP ${{matrix.otp}})
 
-    runs-on: ubuntu-latest
-    timeout-minutes: 5
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
+
+    needs: prevent_duplicate_checks
+    if: ${{ needs.prevent_duplicate_checks.outputs.should-run == 'true' }}
 
-    needs: prevent-duplicate-checks
-    if: ${{ needs.prevent-duplicate-checks.outputs.should-run == 'true' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - elixir: 1.12.x
+            otp: 22
+            os: ubuntu-20.04
+          - elixir: 1.13.x
+            otp: 23
+            os: ubuntu-20.04
+          - elixir: 1.14.x
+            otp: 24
+            os: ubuntu-22.04
+          - elixir: 1.15.x
+            otp: 25
+            os: ubuntu-22.04
+          - elixir: 1.16.x
+            otp: 26
+            os: ubuntu-latest
+
+    env:
+      MIX_ENV: test
 
     steps:
       - name: Checkout code
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
-      - name: Set up Elixir
+      - name: Set up BEAM
+        id: setup-beam
         uses: erlef/setup-beam@61e01a43a562a89bfc54c7f9a378ff67b03e4a21 # v1.16.0
         with:
-          version-type: strict
-          version-file: .tool-versions
+          otp-version: ${{matrix.otp}}
+          elixir-version: ${{matrix.elixir}}
 
       - name: Restore dependencies cache
         uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
         env:
-          cache-name: mix-deps
+          cache-key: deps
         with:
-          path: deps
-          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
-          restore-keys: ${{ runner.os }}-${{ env.cache-name }}-
-
-      - name: Restore build cache
-        uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
-        env:
-          cache-name: mix-build
-        with:
-          path: _build
-          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
-          restore-keys: ${{ runner.os }}-${{ env.cache-name }}-
+          key: ${{ env.cache-key }}-${{ runner.os }}-${{ steps.setup-beam.outputs.otp-version }}-${{ steps.setup-beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}-git-${{ github.sha }}
+          restore-keys: |
+            ${{ env.cache-key }}-${{ runner.os }}-${{ steps.setup-beam.outputs.otp-version }}-${{ steps.setup-beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
+            ${{ env.cache-key }}-${{ runner.os }}-${{ steps.setup-beam.outputs.otp-version }}-${{ steps.setup-beam.outputs.elixir-version }}
+          path: |
+            deps
+            _build
 
       - name: Install dependencies
-        run: mix deps.get
+        run: |
+          mix local.hex --force
+          mix do deps.get, deps.compile
 
       - name: Check formatting
         run: mix format --check-formatted
 
-      - name: Compile code (without warning) and deps
+      - name: Compile code (without warning)
         run: mix compile --warnings-as-errors
 
       - name: Run tests
         run: mix test
+
+      # Dialyzer
+
+      - name: Restore PLTs cache
+        id: restore_plts_cache
+        uses: actions/cache/restore@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
+        env:
+          cache-key: plts
+        with:
+          key: ${{ env.cache-key }}-${{ runner.os }}-${{ steps.setup-beam.outputs.otp-version }}-${{ steps.setup-beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}-git-${{ github.sha }}
+          restore-keys: |
+            ${{ env.cache-key }}-${{ runner.os }}-${{ steps.setup-beam.outputs.otp-version }}-${{ steps.setup-beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
+            ${{ env.cache-key }}-${{ runner.os }}-${{ steps.setup-beam.outputs.otp-version }}-${{ steps.setup-beam.outputs.elixir-version }}
+          path: priv/plts
+
+      - name: Create PLTs
+        if: steps.restore_plts_cache.outputs.cache-hit != 'true'
+        run: |
+          mkdir -p priv/plts/core.plt
+          mix dialyzer --plt
+
+      - name: Save PLTs cache
+        uses: actions/cache/save@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
+        env:
+          cache-key: plts
+        if: steps.restore_plts_cache.outputs.cache-hit != 'true'
+        with:
+          key: ${{ env.cache-key }}-${{ runner.os }}-${{ steps.setup-beam.outputs.otp-version }}-${{ steps.setup-beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}-git-${{ github.sha }}
+          path: priv/plts
+
+      - name: Run dialyzer
+        run: mix dialyzer --format github
+
+  # separate job to set as required status check in branch protection
+  required_check:
+    runs-on: ubuntu-latest
+    needs:
+      - prevent_duplicate_checks
+      - test_matrix
+
+    if: ${{ !cancelled() && needs.prevent_duplicate_checks.outputs.should-run == 'true' }}
+    steps:
+      - name: All required jobs and matrix versions passed
+        if: ${{ !(contains(needs.*.result, 'failure')) }}
+        run: exit 0
+      - name: Some required jobs or matrix versions failed
+        if: ${{ contains(needs.*.result, 'failure') }}
+        run: exit 1
diff --git a/.gitignore b/.gitignore
@@ -27,3 +27,7 @@ nodelix-*.tar
 
 # Node.js dependencies directory
 node_modules
+
+# Dialyzer
+/priv/plts/*.plt
+/priv/plts/*.plt.hash
diff --git a/.releaserc b/.releaserc
@@ -21,7 +21,12 @@
         "config": "@insurgent/conventional-changelog-preset"
       }
     ],
-    "@semantic-release/changelog",
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogTitle": "Changelog"
+      }
+    ],
     "semantic-release-hex",
     [
       "@semantic-release/git",

diff --git a/.tool-versions b/.tool-versions
@@ -1,3 +1,3 @@
-erlang 26.1.2
-elixir 1.15.7
+erlang 24.3.4
+elixir 1.12.3
 nodejs 20.9.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,5 @@
+# Changelog
+
 ## [1.0.0-alpha.3](https://github.com/sheerlox/nodelix/compare/v1.0.0-alpha.2...v1.0.0-alpha.3) (2023-11-24)
 
 
@@ -46,29 +48,6 @@
 * setup semantic-release ([29815b7](https://github.com/sheerlox/nodelix/commit/29815b7421f1357338f8a405ed28ad5ebea02359))
 
 
-### ♻️ Chores
-
-* add license file ([8bf963d](https://github.com/sheerlox/nodelix/commit/8bf963dd4d7f514aaa23ff96110cd42f5c12c82b))
-* initialize project ([f8fc53a](https://github.com/sheerlox/nodelix/commit/f8fc53abd2c81f9ee2854faf0b86d824b56bbe69))
-
-## 1.0.0-alpha.1 (2023-11-22)
-
-
-### 🛠 Builds
-
-* **hex:** add package metadata ([3f773a3](https://github.com/sheerlox/nodelix/commit/3f773a37493fe80ea4b35770588ce3246a42f5af))
-
-
-### 📚 Documentation
-
-* setup ex_doc ([1de8541](https://github.com/sheerlox/nodelix/commit/1de8541a7a9a743fcaa6dd9277c89e1aa8981b13))
-
-
-### ⚙️ Continuous Integrations
-
-* setup semantic-release ([29815b7](https://github.com/sheerlox/nodelix/commit/29815b7421f1357338f8a405ed28ad5ebea02359))
-
-
 ### ♻️ Chores
 
 * add license file ([8bf963d](https://github.com/sheerlox/nodelix/commit/8bf963dd4d7f514aaa23ff96110cd42f5c12c82b))

diff --git a/LICENSE b/LICENSE
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,41 @@
+# Licenses
+
+## `nodelix` (Apache-2.0)
+
+Copyright (c) 2023 Pierre Cavin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+## `tailwind` (MIT)
+
+Copyright (c) 2022 Chris McCord.
+Copyright (c) 2021 Wojtek Mach, José Valim.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.