improve pipelines and setup for GH Actions and changesets (#1124)

Author: dotansimha

.changeset/config.json

@@ -1,6 +1,5 @@
 {
-  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
-  "changelog": "@changesets/cli/changelog",
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
   "commit": false,
   "linked": [],
   "access": "restricted",
@@ -12,5 +11,10 @@
     "@graphql-eslint/example-graphql-config",
     "@graphql-eslint/example-graphql-config-code-file",
     "@graphql-eslint/example-prettier"
-  ]
+  ],
+  "changelog": ["@changesets/changelog-github", { "repo": "B2o5T/graphql-eslint" }],
+  "snapshot": {
+    "useCalculatedVersion": true,
+    "prereleaseTemplate": "{tag}-{datetime}-{commit}"
+  }
 }

.github/workflows/canary.yml

@@ -1,89 +1,47 @@
-name: Canary Release
+name: snapshot
 
 on:
   pull_request:
-    branches: [master]
+    branches:
+      - master
+    paths:
+      - '.changeset/**/*.md'
 
 jobs:
-  changes:
-    name: Check Changeset
+  release:
     runs-on: ubuntu-latest
-    outputs:
-      # Set job outputs to value from filter step
-      wasChangesetChanged: ${{steps.filter.outputs.changeset}}
+    if: github.event.pull_request.head.repo.full_name == github.repository
     steps:
-      - name: Check if changeset has been modified
-        uses: dorny/paths-filter@v2
-        id: filter
-        with:
-          filters: |
-            changeset:
-              - added|modified: .changeset/*.md
-  publish-canary:
-    name: Publish Canary
-    runs-on: ubuntu-latest
-    needs: changes
-    if: github.event.pull_request.head.repo.full_name == github.repository && needs.changes.outputs.wasChangesetChanged == 'true'
-    steps:
-      - name: Checkout Master
+      - name: Checkout
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
       - name: Use Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16
-
-      - name: Configure Git Credentials
-        run: |
-          git config --global user.email "[email protected]"
-          git config --global user.name "theguild-bot"
-          echo "machine github.com login theguild-bot password ${{secrets.GH_API_TOKEN}}" > ~/.netrc
-
-      - name: Setup NPM credentials
-        run: echo "//registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN" >> ~/.npmrc
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
+          node-version: 18
+          cache: yarn
 
-      - name: Cache Yarn
+      - name: Cache Node Modules
         uses: actions/cache@v3
+        id: node-modules-cache-canary
         with:
           path: '**/node_modules'
-          key: ${{runner.os}}-16-16-node-modules-${{hashFiles('yarn.lock')}}
+          key: ${{runner.os}}-18-node-modules-${{hashFiles('yarn.lock')}}
           restore-keys: |
-            ${{runner.os}}-16-16-node-modules-
+            ${{runner.os}}-18-node-modules-
 
-      - name: Install Dependencies
-        run: yarn
+      - name: Install Dependencies using Yarn
+        run: yarn install --ignore-engines --frozen-lockfile --immutable
+        if: steps.node-modules-cache-canary.outputs.cache-hit != 'true'
 
       - name: Release Canary
         id: canary
-        uses: kamilkisiela/release-canary@master
-        if: github.repository == 'B2o5T/graphql-eslint'
+        uses: 'the-guild-org/changesets-snapshot-action@main'
         with:
-          npm-token: ${{secrets.NODE_AUTH_TOKEN}}
-          npm-script: 'yarn release:canary'
-          changesets: true
-
-      - name: Publish a message
-        if: steps.canary.outputs.released
-        uses: kamilkisiela/pr-comment@master
-        with:
-          message: |
-            The latest changes of this PR are available as alpha in npm (based on the declared `changesets`):
-            ```
-            ${{steps.canary.outputs.changesetsPublishedPackages}}
-            ```
-          bot: theguild-bot
-          bot-token: ${{secrets.GH_API_TOKEN}}
-          github-token: ${{secrets.GITHUB_TOKEN}}
-
-      - name: Publish an empty message
-        if: steps.canary.outputs.released == 'false'
-        uses: kamilkisiela/pr-comment@master
-        with:
-          bot: theguild-bot
-          bot-token: ${{secrets.GH_API_TOKEN}}
-          github-token: ${{secrets.GITHUB_TOKEN}}
-          message: The latest changes of this PR are not available as alpha, since there are no linked `changesets` for this PR.
+          tag: alpha
+          prepareScript: 'yarn build'
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/dependencies-changesets.yml

@@ -0,0 +1,19 @@
+name: dependencies
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  changeset:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Create/Update Changesets
+        uses: 'the-guild-org/changesets-dependencies-action@main'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -7,53 +7,35 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout Master
+      - name: Checkout
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
-      - name: Configure Git Credentials
-        run: |
-          git config --global user.email "[email protected]"
-          git config --global user.name "theguild-bot"
-          echo "machine github.com login theguild-bot password ${{secrets.GH_API_TOKEN}}" > ~/.netrc
-
-      - name: Add origin remote and refetch master
-        run: |
-          git remote rm origin
-          git remote add origin "https://github.com/${{github.repository}}"
-          git fetch
-          git checkout master
-          git reset --hard
-
       - name: Use Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16
-
-      - name: Setup NPM credentials
-        run: echo "//registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN" >> ~/.npmrc
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
+          node-version: 18
 
       - name: Cache Yarn
         uses: actions/cache@v3
         with:
           path: '**/node_modules'
-          key: ${{runner.os}}-16-16-node-modules-${{hashFiles('yarn.lock')}}
+          key: ${{runner.os}}-18-18-node-modules-${{hashFiles('yarn.lock')}}
           restore-keys: |
-            ${{runner.os}}-16-16-node-modules-
+            ${{runner.os}}-18-18-node-modules-
 
       - name: Install Dependencies
         run: yarn
 
       - name: Create Release Pull Request or Publish to npm
         id: changesets
-        uses: changesets/action@v1
+        uses: dotansimha/changesets-action@262e957f99be29087d2b13afa32a5d579bf1d080
         with:
-          publish: yarn release
+          publish: 'yarn release'
           commit: 'chore(release): update monorepo packages versions'
-          title: Upcoming Release Changes
+          title: 'Upcoming Release Changes'
+          createGithubReleases: aggregate
         env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-          NPM_TOKEN: ${{secrets.NPM_TOKEN}}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package.json

@@ -19,14 +19,14 @@
     "test": "jest --no-watchman --forceExit --noStackTrace --detectOpenHandles",
     "prerelease": "yarn build",
     "release": "changeset publish",
-    "release:canary": "ts-node scripts/canary-release.ts && yarn build && yarn changeset publish --tag alpha",
     "prettier": "prettier --ignore-path .gitignore --write --list-different \"**/*.{ts,tsx,graphql,yml}\""
   },
   "devDependencies": {
     "@babel/core": "7.18.5",
     "@babel/preset-env": "7.18.2",
     "@babel/preset-typescript": "7.17.12",
-    "@changesets/cli": "2.23.0",
+    "@changesets/cli": "2.24.1",
+    "@changesets/changelog-github": "0.4.6",
     "@swc/core": "1.2.203",
     "@swc/jest": "0.2.21",
     "@types/dedent": "0.7.0",

patches/@changesets+apply-release-plan+6.0.0.patch

@@ -0,0 +1,35 @@
+{
+  "extends": ["config:base"],
+  "postUpdateOptions": ["yarnDedupeFewer"],
+  "automerge": false,
+  "labels": ["dependencies"],
+  "packageRules": [
+    {
+      "matchDepTypes": ["devDependencies"],
+      "prPriority": -1
+    },
+    {
+      "matchPackagePatterns": ["^@theguild/", "^@guild-docs/"],
+      "prPriority": 5
+    },
+    {
+      "excludePackageNames": [
+        "@changesets/cli",
+        "@changesets/apply-release-plan",
+        "@changesets/assemble-release-plan",
+        "typescript"
+      ],
+      "matchPackagePatterns": ["*"],
+      "matchUpdateTypes": ["minor", "patch"],
+      "groupName": "all non-major dependencies",
+      "groupSlug": "all-minor-patch"
+    },
+    {
+      "matchPackageNames": "typescript",
+      "automerge": false
+    }
+  ],
+  "timezone": "Europe/Warsaw",
+  "schedule": ["after 10pm and before 6:00am"],
+  "ignorePaths": ["**/__tests__/**", "**/test/**", "**/tests/**", "**/__fixtures__/**"]
+}