Merge pull request #6 from esl/hex-release

Automatically publish new releases to Hex

Author: mdbrnowski

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         otp_vsn: ['28', '27', '26']
-        rebar_vsn: ['3.25.0']
+        rebar_vsn: ['3.27.0']
     runs-on: 'ubuntu-24.04'
     steps:
       - uses: actions/checkout@v4

.github/workflows/release.yml

@@ -0,0 +1,23 @@
+name: Publish to Hex
+
+on:
+  release:
+    types: [ released ] # pre- and draft releases are excluded
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: "28"
+          rebar3-version: "3.27"
+      - run: rebar3 compile
+      - run: rebar3 hex publish -r hexpm --yes
+        env:
+          HEX_API_KEY: ${{ secrets.HEX_API_KEY }}

.github/workflows/revert-release.yml

@@ -0,0 +1,25 @@
+name: Revert published version from Hex
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Package version to revert (e.g. 1.0.0)"
+        required: true
+        type: string
+
+permissions:
+  contents: read
+
+jobs:
+  revert:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: "28"
+          rebar3-version: "3.27"
+      - run: rebar3 hex publish --revert ${{ inputs.version }} -r hexpm --yes
+        env:
+          HEX_API_KEY: ${{ secrets.HEX_API_KEY }}

README.md

@@ -26,3 +26,11 @@ Allowed = opuntia:peek(Shaper),
 consume_tokens(Allowed),
 {NewShaper, 0} = opuntia:update(Shaper), %% Will suggest no delay if you were diligent and consume less that adviced
 ```
+
+## Releasing to Hex.pm
+
+Creating a GitHub release (non-draft, non-prerelease) automatically publishes the package to [Hex.pm](https://hex.pm/) via the **Publish to Hex** workflow.
+This workflow can also be triggered manually from the Actions tab — make sure to run it from the specific tag you want to publish.
+
+To revert a published version, run the **Revert published version from Hex** workflow from the Actions tab, providing the version to revert.
+Hex.pm only allows reverting within 1 hour of publishing — after that, the version can only be *retired*.