ci: release and nightly release automation (#230)

* feat: release and nightly release automation

* fix: nightly npm badge

Author: BobbieGoede

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ on:
       - main
 
 jobs:
-  ci:
+  test:
     runs-on: ${{ matrix.os }}
 
     strategy:
@@ -47,3 +47,46 @@ jobs:
 
       - name: Build project
         run: pnpm build
+
+      - name: Cache dist
+        uses: actions/cache@v4
+        with:
+          path: dist
+          key: ${{ matrix.os }}-node-v${{ matrix.node }}-${{ github.sha }}
+
+  nightly-release:
+    needs:
+      - test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node: [18]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+
+      - run: corepack enable
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Restore dist cache
+        uses: actions/cache@v4
+        with:
+          path: dist
+          key: ${{ matrix.os }}-node-v${{ matrix.node }}-${{ github.sha }}
+
+      - name: Release Nightly
+        if: |
+          github.event_name == 'push' &&
+          !startsWith(github.event.head_commit.message, '[skip-release]') &&
+          !startsWith(github.event.head_commit.message, 'chore') &&
+          !startsWith(github.event.head_commit.message, 'docs')
+        run: ./scripts/release-nightly.sh
+        env:
+          NPM_TOKEN: ${{secrets.NPM_TOKEN}}

.github/workflows/release.yaml

@@ -0,0 +1,62 @@
+name: Release
+
+# trigger by `git tag` push only via `yarn release`
+on:
+  push:
+    branches-ignore:
+      - '**'
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout codes
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Enable corepack
+        run: corepack enable
+
+      - name: Setup node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Create github releases
+        run: |
+          npx changelogithub
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+      - name: Extract version tag
+        if: startsWith( github.ref, 'refs/tags/v' )
+        uses: jungwinter/split@v2
+        id: split
+        with:
+          msg: ${{ github.ref }}
+          separator: /
+
+      - name: Sync changelog from github releases
+        run: |
+          pnpm changelog --tag=${{ steps.split.outputs._2 }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Commit changelog
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          branch: main
+          file_pattern: CHANGELOG.md
+          commit_message: 'chore: generate changelog'
+
+      - name: Publish package
+        run: ./scripts/release.sh
+        env:
+          NPM_TOKEN: ${{secrets.NPM_TOKEN}}

README.md

@@ -1,6 +1,7 @@
 # 🤹 @vueuse/motion
 
 [![npm](https://img.shields.io/npm/v/@vueuse/motion.svg)](https://www.npmjs.com/package/@vueuse/motion)
+[![npm](https://img.shields.io/npm/v/@vueuse/motion-nightly.svg)](https://www.npmjs.com/package/@vueuse/motion-nightly)
 [![npm](https://img.shields.io/npm/dm/@vueuse/motion.svg)](https://npm-stat.com/charts.html?package=@vueuse/motion)
 [![Netlify Status](https://api.netlify.com/api/v1/badges/ab1db459-8420-4bc6-9fac-2bc247fa2385/deploy-status)](https://app.netlify.com/sites/vueuse-motion/deploys)
 
@@ -25,7 +26,7 @@ Let's get started by installing the package and adding the plugin.
 From your terminal:
 
 ```bash
-yarn add @vueuse/motion
+npm install @vueuse/motion
 ```
 
 In your Vue app entry file:
@@ -70,6 +71,14 @@ To see more about what are variants and how you can use them, check out [Variant
 
 To see more about how to control your declared variants, check out [Motion Instance](https://motion.vueuse.org/features/motion-instance).
 
+## Nightly release channel
+
+You can try out the latest changes before a stable release by installing the nightly release channel.
+
+```bash
+npm install @vueuse/motion@npm:@vueuse/motion-nightly
+```
+
 ## Credits
 
 This package is heavily inspired by [Framer Motion](https://www.framer.com/motion/) by [@mattgperry](https://twitter.com/mattgperry).

package.json

@@ -50,13 +50,15 @@
     "build": "unbuild && pnpm build:nuxt-module",
     "build:nuxt-module": "nuxt-module-build build ./src/nuxt --outDir ../../dist/nuxt",
     "dev": "pnpm dev:vite",
-    "release": "release-it",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "test:unit": "vitest run",
     "test:coverage": "vitest run --coverage",
     "test": "pnpm test:unit && pnpm test:coverage",
     "prepare": "pnpm prepare:nuxt && pnpm prepare:docs",
+    "prepack": "pnpm build",
+    "release": "bumpp --commit \"release: v%s\" --push --tag",
+    "changelog": "gh-changelogen --repo=vueuse/motion",
     "__": "__",
     "dev:nuxt": "(cd playgrounds/nuxt && pnpm dev:nuxt)",
     "build:nuxt": "(cd playgrounds/nuxt && pnpm build:nuxt)",
@@ -94,9 +96,13 @@
     "@nuxt/schema": "^3.13.0",
     "@vitest/coverage-v8": "^1.6.0",
     "@vue/test-utils": "^2.4.6",
+    "bumpp": "^9.5.2",
+    "changelogithub": "^0.13.10",
     "chokidar": "^3.6.0",
     "eslint": "^9.3.0",
+    "gh-changelogen": "^0.2.8",
     "happy-dom": "^14.12.0",
+    "jiti": "^1.21.6",
     "lint-staged": "^15.2.5",
     "nuxt": "^3.13.0",
     "pkg-pr-new": "^0.0.20",
@@ -126,22 +132,5 @@
         "vite": "^4.0.0"
       }
     }
-  },
-  "release-it": {
-    "hooks": {
-      "before:init": [
-        "pnpm build"
-      ]
-    },
-    "npm": {
-      "access": "public"
-    },
-    "git": {
-      "commitMessage": "chore(release): release v${version}"
-    },
-    "github": {
-      "release": true,
-      "releaseName": "v${version}"
-    }
   }
 }