ci: merge ci and release workflow (#37)

* refactor: update ci workflow * chore: remove old release workflow * chore: add missing tasks * fix: TS issue * chore: ignore vue TypeScript configuration issue * chore: update TS config * chore: add format and format:check scripts * chore: code style * fix: wrong test script * chore: add missing tsconfig * docs: remove release badge
scalar · Aug 1, 2024 · 05bd2cd · 05bd2cd
1 parent 9e800f1
commit 05bd2cd
Show file tree

Hide file tree

Showing 35 changed files with 478 additions and 279 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -1,11 +1,11 @@
 {
-    "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
-    "changelog": "@changesets/cli/changelog",
-    "commit": ["@changesets/cli/commit", { "skipCI": false }],
-    "fixed": [],
-    "linked": [],
-    "access": "public",
-    "baseBranch": "main",
-    "updateInternalDependencies": "patch",
-    "ignore": ["demo"]
-  }
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": ["@changesets/cli/commit", { "skipCI": false }],
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": ["demo"]
+}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,20 +1,96 @@
 name: CI
 
 on:
-  pull_request:
+  push:
     branches:
       - main
-  push:
+  pull_request:
     branches:
       - main
 
 jobs:
-  lint:
+  # Always use Node 20
+  # Add Node 18 to the matrix if we’re in the release PR
+  define-matrix:
+    runs-on: ubuntu-latest
+
+    outputs:
+      node-versions: ${{ steps.node-versions.outputs.node-versions }}
+
+    steps:
+      - name: Node version matrix
+        id: node-versions
+        run: |
+          if [ "${{ github.head_ref }}" == "changeset-release/main" ]; then
+            echo 'node-versions=[18, 20]' >> "$GITHUB_OUTPUT"
+          else
+            echo 'node-versions=[20]' >> "$GITHUB_OUTPUT"
+          fi
+      - name: Print Node version matrix
+        run: echo "node-versions=${{ steps.node-versions.outputs.node-versions }}"
+      - name: Check Node version matrix
+        run: |
+          if [ "${{ steps.node-versions.outputs.node-versions }}" != "[18, 20]" ] && [ "${{ steps.node-versions.outputs.node-versions }}" != "[20]" ]; then
+            echo "Node version matrix is not [18, 20] or [20]"
+            exit 1
+          fi
+
+  build:
+    runs-on: ubuntu-20.04
+    needs: define-matrix
+    strategy:
+      matrix:
+        node-version: ${{ fromJSON(needs.define-matrix.outputs.node-versions) }}
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
+      - name: Turborepo cache
+        uses: actions/cache@v4
+        with:
+          path: .turbo
+          key: turbo-${{ runner.os }}-node-${{ matrix.node-version }}
+      - name: Build
+        run: pnpm turbo build
+      - name: Update Turborepo cache
+        uses: actions/cache/save@v4
+        with:
+          path: .turbo
+          key: turbo-${{ runner.os }}-node-${{ matrix.node-version }}
+
+  format:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
         node-version: [20]
 
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+      - name: Install dev dependencies
+        run: pnpm install --dev
+      - name: Check code style
+        run: pnpm format:check
+
+  types:
+    runs-on: ubuntu-20.04
+    needs: [define-matrix, build]
+    strategy:
+      matrix:
+        node-version: ${{ fromJSON(needs.define-matrix.outputs.node-versions) }}
+
     steps:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v4
@@ -26,8 +102,94 @@ jobs:
       - name: Install dependencies
         run: pnpm install
       - name: Turborepo cache
-        uses: dtinth/setup-github-actions-caching-for-turbo@v1
+        uses: actions/cache/restore@v4
+        with:
+          path: .turbo
+          key: turbo-${{ runner.os }}-node-${{ matrix.node-version }}
+      - name: Build
+        run: pnpm turbo build
+      - if: matrix.node-version == 20 || github.head_ref == 'changeset-release/main'
+        name: Check types
+        run: pnpm turbo types:check
+
+  test:
+    runs-on: ubuntu-20.04
+    needs: [define-matrix, build]
+    strategy:
+      matrix:
+        node-version: ${{ fromJSON(needs.define-matrix.outputs.node-versions) }}
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
+      - name: Turborepo cache
+        uses: actions/cache/restore@v4
+        with:
+          path: .turbo
+          key: turbo-${{ runner.os }}-node-${{ matrix.node-version }}
+      - name: Build
+        run: pnpm build
+      - name: Run tests
+        run: pnpm test
+
+  release:
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-20.04
+    permissions:
+      contents: write
+      id-token: write
+    needs: [build, test]
+    strategy:
+      matrix:
+        node-version: [20]
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
+      - name: Turborepo cache
+        uses: actions/cache/restore@v4
+        with:
+          path: .turbo
+          key: turbo-${{ runner.os }}-node-${{ matrix.node-version }}
+      - name: Build
+        run: pnpm turbo build
+      - name: Git Status
+        run: git status
+      - name: Stash changes
+        run: git stash
+      - name: Create Release Pull Request or Publish to npm
+        id: changesets
+        uses: changesets/action@v1
         with:
-          cache-prefix: snippetz
-      - name: Build & test
-        run: pnpm turbo test
+          # The pull request title.
+          title: 'chore: release'
+          # The command to update version, edit CHANGELOG, read and delete changesets.
+          version: 'pnpm changeset version'
+          # The commit message to use.
+          commit: 'chore: version packages'
+          # The command to use to build and publish packages
+          publish: 'pnpm -r publish --access public'
+        env:
+          # https://github.com/settings/tokens/new
+          # Expiration: No expiration
+          # Select: repo.*
+          GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
+          # https://www.npmjs.com/settings/YOUR_ACCOUNT_HANDLE/tokens/granular-access-tokens/new
+          # Custom Expiration: 01-01-2100
+          # Permissions: Read and Write
+          # Select packages: @scalar
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,20 @@
+**/.git
+**/.svn
+**/.hg
+**/node_modules
+**/dist/**
+**/.turbo/**
+**/build/**
+**/.next/**
+**/.nuxt/**
+
+/venv/
+**/venv
+/.venv/
+**/.venv
+
+pnpm-lock.yaml
+.changeset/*.md
+
+.vite-ssg-temp
+.next
diff --git a/.prettierrc b/.prettierrc
@@ -3,4 +3,4 @@
   "tabWidth": 2,
   "semi": false,
   "singleQuote": true
-}
+}
diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 # Snippetz
 
 [![CI](https://github.com/scalar/snippetz/actions/workflows/ci.yml/badge.svg)](https://github.com/scalar/snippetz/actions/workflows/ci.yml)
-[![Release](https://github.com/scalar/snippetz/actions/workflows/release.yml/badge.svg)](https://github.com/scalar/snippetz/actions/workflows/release.yml)
 [![Contributors](https://img.shields.io/github/contributors/scalar/snippetz)](https://github.com/scalar/snippetz/graphs/contributors)
 [![GitHub License](https://img.shields.io/github/license/scalar/snippetz)](https://github.com/scalar/snippetz/blob/main/LICENSE)
 [![Version](https://img.shields.io/npm/v/%40scalar/snippetz)](https://www.npmjs.com/package/@scalar/snippetz)
@@ -24,7 +23,7 @@ npm install @scalar/snippetz
 import { snippetz } from '@scalar/snippetz'
 
 const snippet = snippetz().print('node', 'undici', {
-  url: 'https://example.com'
+  url: 'https://example.com',
 })
 
 /* Output */
@@ -73,7 +72,7 @@ const snippet = snippetz().hasPlugin('node', 'undici')
 import { undici } from '@scalar/snippetz-plugin-undici'
 
 const source = undici({
-  url: 'https://example.com'
+  url: 'https://example.com',
 })
 
 console.log(source.code)
@@ -118,4 +117,4 @@ Contributions are welcome! Read [`CONTRIBUTING`](https://github.com/scalar/snipp
 
 ## License
 
-The source code in this repository is licensed under [MIT](https://github.com/scalar/snippetz/blob/main/LICENSE).
+The source code in this repository is licensed under [MIT](https://github.com/scalar/snippetz/blob/main/LICENSE).
diff --git a/demo/index.html b/demo/index.html
@@ -1,10 +1,13 @@
-<!doctype html>
+<!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Snippetz / Opinionated HTTP Snippets</title>
-    <link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>🌐</text></svg>">
+    <link
+      rel="icon"
+      href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>🌐</text></svg>"
+    />
   </head>
   <body>
     <div id="app"></div>

diff --git a/demo/package.json b/demo/package.json
@@ -6,6 +6,8 @@
   "scripts": {
     "dev": "vite",
     "build": "vue-tsc && vite build",
+    "types:build": "vue-tsc -p tsconfig.build.json",
+    "types:check": "vue-tsc --composite false",
     "preview": "vite preview"
   },
   "dependencies": {