feat: add release automation (#581)

elixirs · Jan 31, 2025 · 0d08ed2 · 0d08ed2
1 parent 59951ec
commit 0d08ed2
Show file tree

Hide file tree

Showing 10 changed files with 7,023 additions and 16 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -1,7 +1,6 @@
 name: ci
 
 on:
-  push:
   pull_request:
 
 jobs:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,69 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    uses: ./.github/workflows/ci.yml
+    permissions:
+      contents: read
+
+  release:
+    needs: test
+
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout code
+        uses: actions/[email protected]
+        with:
+          persist-credentials: false
+
+      - name: Set up Elixir
+        id: setup-beam
+        uses: erlef/[email protected]
+        with:
+          version-type: strict
+          version-file: .tool-versions
+
+      - name: Restore dependencies cache
+        uses: actions/[email protected]
+        env:
+          cache-key: deps
+        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: |
+            deps
+            _build
+
+      - name: Install dependencies
+        run: |
+          mix local.hex --force
+          mix do deps.get, deps.compile
+
+      - name: Use Node.js LTS
+        uses: actions/[email protected]
+        with:
+          node-version-file: ".tool-versions"
+
+      - name: Install packages
+        run: npm ci
+
+      - name: Audit npm signatures
+        run: npm audit signatures
+
+      - name: Run Semantic Release
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.CI_GITHUB_TOKEN }}
+          HEX_API_KEY: ${{ secrets.HEX_API_KEY }}
diff --git a/.gitignore b/.gitignore
@@ -1,12 +1,13 @@
+*.ez
+*.iml
+*.swp
+.DS_Store
+.envrc
+/.elixir_ls
+/.idea
+/.vscode
 /_build
 /deps
-/.idea
 /doc
-/.elixir_ls
-/.vscode
+/node_modules
 erl_crash.dump
-*.ez
-*.swp
-*.iml
-.DS_Store
-.tool-versions
diff --git a/.releaserc.json b/.releaserc.json
@@ -0,0 +1,90 @@
+{
+  "branches": [
+    "master",
+    {
+      "name": "dev",
+      "prerelease": "alpha",
+      "channel": "alpha"
+    }
+  ],
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits",
+        "releaseRules": [],
+        "parserOpts": {
+          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]
+        }
+      }
+    ],
+    [
+      "@semantic-release/release-notes-generator",
+      {
+        "preset": "conventionalcommits",
+        "parserOpts": {
+          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]
+        },
+        "writerOpts": {
+          "commitsSort": ["subject", "scope"]
+        }
+      }
+    ],
+    [
+      "semantic-release-replace-plugin",
+      {
+        "replacements": [
+          {
+            "files": ["mix.exs"],
+            "from": "@version \".*\"",
+            "to": "@version \"${nextRelease.version}\"",
+            "results": [
+              {
+                "file": "mix.exs",
+                "hasChanged": true,
+                "numMatches": 1,
+                "numReplacements": 1
+              }
+            ],
+            "countMatches": true
+          },
+          {
+            "files": ["README.md"],
+            "from": "\"~> .*\"",
+            "to": "\"~> ${nextRelease.version}\"",
+            "results": [
+              {
+                "file": "README.md",
+                "hasChanged": true,
+                "numMatches": 2,
+                "numReplacements": 2
+              }
+            ],
+            "countMatches": true
+          }
+        ]
+      }
+    ],
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogFile": "CHANGELOG.md",
+        "changelogTitle": "# Changelog"
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["mix.exs", "README.md", "CHANGELOG.md"],
+        "message": "chore(release): v${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ],
+    "@semantic-release/github",
+    [
+      "@semantic-release/exec",
+      {
+        "publishCmd": "mix hex.publish --yes"
+      }
+    ]
+  ]
+}
diff --git a/.tool-versions b/.tool-versions
@@ -0,0 +1,3 @@
+erlang 27.2
+elixir 1.18.1
+nodejs 22.13.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-# Change Log
+# Changelog
 
 All notable changes to this project will be documented in this file.
 
@@ -66,13 +66,15 @@ Change log itself follows [Keep a CHANGELOG](http://keepachangelog.com) format.
 ### Deprecated
 
 ### Removed
+
 - Travis CI for CI workflow [[@anthonator](https://github.com/anthonator)]
 
 ### Fixed
 
 - `Faker.Team` `creature/0` and `name/0` documentation examples fixed [[@yuriploc](https://github.com/yuriploc)]
 - Fix bidirectional formatting [[@MichalDolata](https://github.com/MichalDolata)]
 - Extra split for Virgin Islands in the country sampler [[intercaetera](https://github.com/intercaetera)]
+
 ### Security
 
 ## 0.16.0
@@ -147,6 +149,7 @@ Change log itself follows [Keep a CHANGELOG](http://keepachangelog.com) format.
 - `Faker.Phone.PtBr`[[@netond](https://github.com/netond)]
 
 ### Changed
+
 - Fix `Faker.Code.Iban.iban` and `Faker.Gov.It.fiscal_id` doctests [[@vbrazo](https://github.com/vbrazo)]
 - `Faker.Address.Es` [[@emig](https://github.com/emig)]
 - Set minimum Elixir version to 1.6
@@ -165,6 +168,7 @@ Change log itself follows [Keep a CHANGELOG](http://keepachangelog.com) format.
 - Elixir 1.4 and 1.5 support
 
 ### Fixed
+
 - `Faker.Util.upper_letter/0` documentation examples [[@michaelfich](https://github.com/michaelfich)]
 
 ### Security

diff --git a/lib/faker/airports.ex b/lib/faker/airports.ex
@@ -1029,13 +1029,13 @@ defmodule Faker.Airports do
   ## Examples
 
       iex> Faker.Airports.iata()
-      "BFU"
+      "UBJ"
       iex> Faker.Airports.iata()
-      "FMM"
+      "CKB"
       iex> Faker.Airports.iata()
-      "YUS"
+      "JAL"
       iex> Faker.Airports.iata()
-      "YPH"
+      "PES"
   """
   @spec iata() :: String.t()
   sampler(:iata, [

diff --git a/mix.exs b/mix.exs
@@ -14,6 +14,8 @@ defmodule Faker.Mixfile do
       name: "Faker",
       deps: deps(),
       docs: docs(),
+      source_url: @source_url,
+      homepage_url: @source_url,
       preferred_cli_env: [
         "test.watch": :test
       ],
@@ -63,11 +65,11 @@ defmodule Faker.Mixfile do
   end
 
   defp package do
-    %{
+    [
       maintainers: ["Anthony Smith", "Igor Kapkov", "Toby Hinloopen", "Vitor Oliveira"],
       files: ["lib", "mix.exs", "mix.lock", "README.md", "LICENSE", "CHANGELOG.md"],
       licenses: ["MIT"],
       links: %{"GitHub" => @source_url}
-    }
+    ]
   end
 end