chore(ci): added new workflows (#31)

.changeset/config.json

@@ -1,6 +1,9 @@
 {
   "$schema": "https://unpkg.com/@changesets/config@2.2.0/schema.json",
-  "changelog": "@changesets/cli/changelog",
+  "changelog": [
+    "@changesets/changelog-github",
+    { "repo": "DuCanhGH/next-pwa" }
+  ],
   "commit": false,
   "fixed": [],
   "linked": [],

.changeset/sour-laws-look.md

@@ -0,0 +1,2 @@
+---
+---

.github/workflows/build-and-test.yml

@@ -0,0 +1,18 @@
+name: Build and test
+on: [workflow_call]
+env:
+  TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+  TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
+  TURBO_REMOTE_ONLY: true
+jobs:
+  # TODO: add tests
+  build_and_test:
+    name: 🔎 Typecheck, check formatting and lint
+    uses: ./.github/workflows/build-reusable.yml
+    with:
+      afterBuild: |
+        pnpm typecheck &&
+        pnpm format:check &&
+        pnpm lint &&
+        pnpm docs:lint
+    secrets: inherit

.github/workflows/build-reusable.yml

@@ -0,0 +1,53 @@
+name: Build reusable
+on:
+  workflow_call:
+    inputs:
+      skipInstallBuild:
+        required: false
+        description: "whether to skip pnpm install && pnpm build"
+        type: string
+      nodeVersion:
+        required: false
+        description: "version of Node.js to use"
+        type: string
+      pnpmVersion:
+        required: false
+        description: "version of pnpm to use"
+        type: string
+      afterBuild:
+        required: false
+        description: "additional steps to run"
+        type: string
+env:
+  TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+  TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
+  TURBO_REMOTE_ONLY: true
+jobs:
+  build:
+    name: ⬣, 🔎, 🔨 Typecheck, lint, and build on Node ${{ matrix.node-version }} and ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node-version: ${{ fromJson(inputs.nodeVersion || '["18.x"]') }}
+        pnpm-version: ${{ fromJson(inputs.pnpmVersion || '["8.x"]') }}
+        os: [ubuntu-latest]
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+      - name: Use pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: ${{ matrix.pnpm-version }}
+      - name: Use Node ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "pnpm"
+      - name: Install dependencies
+        run: pnpm install
+        if: ${{ inputs.skipInstallBuild != 'yes' }}
+      - name: Build
+        run: pnpm build
+        if: ${{ inputs.skipInstallBuild != 'yes' }}
+      - name: Run after build
+        run: /bin/bash -c "${{ inputs.afterBuild }}"

.github/workflows/close-stale.yml

@@ -5,7 +5,6 @@ on:
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
-
 jobs:
   close-issues:
     runs-on: ubuntu-latest

.github/workflows/npm-publish.yml

@@ -1,58 +1,31 @@
-name: Test & Publish package to npm
-on: [push]
+name: Publish packages to npm
+on:
+  push:
+    branches:
+      - master
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
+env:
+  TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+  TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
+  TURBO_REMOTE_ONLY: true
 jobs:
-  typecheck_lint_build:
-    name: ⬣, 🔎, 🔨 Typecheck, lint, and build on Node ${{ matrix.node-version }} and ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    env:
-      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
-      TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
-      TURBO_REMOTE_ONLY: true
-    strategy:
-      matrix:
-        node-version: ["18.x"]
-        pnpm-version: ["8.x"]
-        os: [ubuntu-latest]
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v3
-      - name: Use pnpm
-        uses: pnpm/action-setup@v2
-        with:
-          version: ${{ matrix.pnpm-version }}
-      - name: Use Node ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: "pnpm"
-      - name: Install dependencies
-        run: pnpm install
-      - name: Build
-        run: pnpm build
-      - name: Typecheck
-        run: pnpm typecheck
-      - name: Lint
-        run: pnpm lint
+  test:
+    name: ⬣, 🔎, 🔨 Test before releasing
+    uses: ./.github/workflows/build-and-test.yml
   publish:
     name: 🚀 Release packages
-    needs: [typecheck_lint_build]
-    runs-on: ${{ matrix.os }}
+    needs: [test]
+    runs-on: [ubuntu-latest]
     permissions:
       contents: write
       id-token: write
-    env:
-      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
-      TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
-      TURBO_REMOTE_ONLY: true
     strategy:
       matrix:
         node-version: ["18.x"]
         pnpm-version: ["8.x"]
-        os: [ubuntu-latest]
-    if: ${{ github.ref == 'refs/heads/master' && (contains(github.event.head_commit.message, '[bump]') || contains(github.event.head_commit.message, 'RELEASING')) }}
+    if: ${{ contains(github.event.head_commit.message, '[bump]') || github.event.head_commit.message == 'Publish packages' }}
     steps:
       - name: Checkout repo
         uses: actions/checkout@v3

.github/workflows/pull-request-checks.yml

@@ -0,0 +1,37 @@
+name: Check a pull request
+on:
+  pull_request:
+    types: [opened, synchronize]
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+env:
+  TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+  TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
+  TURBO_REMOTE_ONLY: true
+jobs:
+  ensure_changelog_exists:
+    name: 🔎 Ensure that .changeset is not empty
+    runs-on: [ubuntu-latest]
+    strategy:
+      matrix:
+        node-version: ["18.x"]
+        pnpm-version: ["8.x"]
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0
+      - name: Use Node ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install changeset CLI
+        run: npm i -g @changesets/cli@$(node -p "require('./package.json').devDependencies['@changesets/cli']")
+      - name: Ensure that a changelog is added
+        run: npx changeset status --since=origin/master
+  test:
+    name: ⬣, 🔎, 🔨 Test PR
+    uses: ./.github/workflows/build-and-test.yml
+    secrets: inherit

package.json

@@ -19,6 +19,7 @@
     "examples:dev": "cross-env FORCE_COLOR=1 turbo run dev --parallel --filter=./examples/*",
     "examples:lint": "cross-env FORCE_COLOR=1 turbo run lint --parallel --filter=./examples/*",
     "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "lint": "cross-env FORCE_COLOR=1 turbo run lint --parallel --filter=./packages/*",
     "lint-staged": "lint-staged",
     "new-changeset": "changeset",
@@ -27,6 +28,7 @@
     "typecheck": "cross-env FORCE_COLOR=1 turbo run typecheck"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "0.4.8",
     "@changesets/cli": "2.26.1",
     "@ducanh2912/next-pwa": "workspace:*",
     "@ducanh2912/next-sw": "workspace:*",