chore(sematic-release): Set up semantic-release with Hackage plugin (#43)

* add package json with release script

* set yarn version

* add .nvmrc file

* update release workflow

* add releaserc

* requested changes

* add requested changes to release workflow

Author: dalejo96

.github/workflows/draft.yml

@@ -5,21 +5,57 @@
 name: Release
 
 on:
-  release:
-    types:
-      - published
+  workflow_dispatch:
 
 concurrency:
-  group: release-${{ github.ref }}
+  group: release
   cancel-in-progress: true
 
 jobs:
-  cabal-upload:
-    uses: stackbuilders/reusable-workflows/.github/workflows/cabal-upload.yml@main
-    with:
-      ghc_version: "8.10"
-      cabal_version: "3.6"
-      ignore_uploaded_package: true
-    secrets:
-      HACKAGE_USERNAME: ${{ secrets.HACKAGE_USERNAME }}
-      HACKAGE_PASSWORD: ${{ secrets.HACKAGE_PASSWORD }}
+  upload:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup tooling
+        uses: haskell/actions/setup@v2
+        with:
+          ghc-version: "8.10"
+          cabal-version: "3.6"
+      - name: Freeze dependencies
+        run: cabal freeze
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          key: ${{ runner.os }}-${{ hashFiles('*.cabal', 'cabal.project.freeze') }}
+          restore-keys: ${{ runner.os }}-
+          path: |
+            ~/.cabal/packages
+            ~/.cabal/store
+            dist-newstyle
+      - name: Setup NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: yarn
+      - name: Install packages
+        command: yarn install --immutable
+      - name: Publish package to Hackage
+        command: yarn release
+        env:
+          HACKAGE_TOKEN: ${{ secrets.HACKAGE_API_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Generate documentation
+        run: cabal v2-haddock --haddock-for-hackage --enable-documentation
+      - name: Upload documentation to Hackage
+        run: |
+          cabal upload --publish \
+            --username "${{ secrets.HACKAGE_USERNAME }}" \
+            --password "${{ secrets.HACKAGE_PASSWORD }}" \
+            --documentation \
+            dist-newstyle/*-docs.tar.gz

.github/workflows/release.yml

@@ -21,3 +21,15 @@ cabal.project.local
 cabal.project.local~
 .HTF/
 .ghc.environment.*
+
+# VSCode
+.vscode
+
+# NodeJS
+node_modules/
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.gitignore

@@ -0,0 +1 @@
+21.6.2

.nvmrc

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json.schemastore.org/semantic-release",
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "semantic-release-hackage",
+      {
+        "packageName": "atomic-write",
+        "versionPrefix": "0."
+      }
+    ],
+    "@semantic-release/github"
+  ],
+  "tagFormat": "v0.${version}"
+}

.releaserc.json

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.1.0.cjs

.yarn/releases/yarn-4.1.0.cjs

@@ -0,0 +1,19 @@
+{
+  "name": "atomic-write",
+  "version": "0.0.0",
+  "description": "Writes files atomically in Haskell while preserving permissions",
+  "repository": "[email protected]:stackbuilders/atomic-write.git",
+  "author": "Stack Builders <[email protected]>",
+  "license": "MIT",
+  "engines": {
+    "node": "21.6.2"
+  },
+  "scripts": {
+    "release": "semantic-release"
+  },
+  "devDependencies": {
+    "semantic-release": "^23.0.2",
+    "semantic-release-hackage": "^1.0.0"
+  },
+  "packageManager": "[email protected]"
+}