From e941848f3123e371f2cafee620f947d1ceee2806 Mon Sep 17 00:00:00 2001 From: Simone Cottini Date: Fri, 1 Dec 2023 09:17:57 +0100 Subject: [PATCH] Add CI GHA --- .github/workflows/cd.yml | 39 ++++++++++++++++++ .github/workflows/ci.yml | 77 ++++++++++++++++++++++++++++++++++++ .github/workflows/retire.yml | 44 +++++++++++++++++++++ 3 files changed, 160 insertions(+) create mode 100644 .github/workflows/cd.yml create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/retire.yml diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml new file mode 100644 index 0000000..9c72398 --- /dev/null +++ b/.github/workflows/cd.yml @@ -0,0 +1,39 @@ +name: CD + +on: + release: + types: [published] + +jobs: + release: + runs-on: ubuntu-latest + steps: + - name: Setup Elixir + uses: erlef/setup-beam@v1 + with: + otp-version: '24' + elixir-version: '1.13' + - name: Checkout + uses: actions/checkout@v3 + - name: setup hex + run: | + mix local.hex --force + mix local.rebar --force + - name: Get deps + run: mix deps.get + - name: Get version + run: | + VERSION=$(grep -m1 version mix.exs | cut -d'"' -f2) + echo "VERSION=$VERSION" >> $GITHUB_ENV + - name: Check version + if: ${{ github.event.release.tag_name != env.VERSION }} + run: | + echo "Github ref tag [${{ github.event.release.tag_name }}] is different from mix.exs version [${{ env.VERSION }}]" + exit 1 + - name: Login to hex.pm + run: | + mix hex.config api_key "$HEX_AUTH_KEY" + env: + HEX_AUTH_KEY: ${{ secrets.HEX_AUTH_KEY }} + - name: Publish + run: mix hex.publish --yes diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..69a11be --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,77 @@ +name: CI + +on: [push, pull_request] + +jobs: + ci: + # Avoid duplicate jobs on PR from a branch on the same repo + if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name + runs-on: ubuntu-latest + env: + MIX_ENV: test + steps: + - uses: erlef/setup-beam@v1 + with: + elixir-version: 1.13 + otp-version: 24 + + # Check out the code. + - name: Checkout + uses: actions/checkout@v3 + + # Define how to cache deps. Restores existing cache if present. + - name: Cache deps + id: cache-deps + uses: actions/cache@v3 + env: + cache-name: cache-elixir-deps + with: + path: deps + key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }} + restore-keys: | + ${{ runner.os }}-mix-${{ env.cache-name }}- + # Define how to cache the `_build` directory. + # After the first run, this speeds up tests runs a lot. + # This includes not re-compiling our project's downloaded deps every run. + - name: Cache compiled build + id: cache-build + uses: actions/cache@v3 + env: + cache-name: cache-compiled-build + with: + path: _build + key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }} + restore-keys: | + ${{ runner.os }}-mix-${{ env.cache-name }}- + ${{ runner.os }}-mix- + # Conditionally bust the cache when job is re-run. + # Sometimes, we may have issues with incremental builds that are fixed by doing a full recompile. + # In order to not waste dev time on such trivial issues force a full recompile only on builds that are retried. + # See https://fly.io/docs/elixir/advanced-guides/github-actions-elixir-ci-cd/ for more infos + - name: Clean to rule out incremental build as a source of flakiness + if: github.run_attempt != '1' + run: | + mix deps.clean --all + mix clean + - name: Deps get + run: mix deps.get + - name: Dependencies Check + run: mix deps.unlock --check-unused + - name: Compiles without warnings + run: mix compile --warnings-as-errors + - name: Check Formatting + run: mix format --check-formatted + - name: Credo + run: mix credo -a --strict + - name: Test + run: mix test + - name: Dialyzer + run: mix dialyzer + + alls-green: + if: always() && (github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name) + runs-on: ubuntu-latest + needs: + - ci + steps: + - run: ${{ !contains(needs.*.result, 'failure') }} diff --git a/.github/workflows/retire.yml b/.github/workflows/retire.yml new file mode 100644 index 0000000..263206a --- /dev/null +++ b/.github/workflows/retire.yml @@ -0,0 +1,44 @@ +on: + workflow_dispatch: + inputs: + reason: + description: Retire reason + required: true + default: invalid + type: choice + options: + - renamed + - deprecated + - security + - invalid + - other + message: + description: Retire message + required: true + default: Version has a breaking bug + type: string + version: + description: Version to retire + required: true + default: x.y.z + type: string + +jobs: + retire: + runs-on: ubuntu-latest + env: + MESSAGE: ${{ inputs.message }} + REASON: ${{ inputs.reason }} + VERSION: ${{ inputs.version }} + steps: + - uses: actions/checkout@v4 + - uses: erlef/setup-beam@v1 + with: + otp-version: '24' + elixir-version: '1.13' + - run: echo "Attempting to retire version $VERSION" + - run: mix hex.config api_key "$HEX_AUTH_KEY" + env: + HEX_AUTH_KEY: ${{ secrets.HEX_AUTH_KEY }} + - run: mix hex.user whoami + - run: mix hex.retire csv_schema "$VERSION" "$REASON" --message "$MESSAGE"