chore: setup changeset for release (#1014)

* chore: setup changeset for release

* use v16 node for now

Author: saihaj

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": [
+    "@changesets/changelog-github",
+    { "repo": "graphprotocol/graph-cli" } 
+  ],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": [
+    "basic-event-handlers",
+    "example-*"
+  ],
+  "snapshot": {
+    "useCalculatedVersion": true,
+    "prereleaseTemplate": "{tag}-{datetime}-{commit}"
+  }
+}

.github/workflows/pr.yml

@@ -0,0 +1,21 @@
+name: Snapshot Release
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  dependencies:
+    uses: the-guild-org/shared-config/.github/workflows/changesets-dependencies.yaml@main
+    secrets:
+      githubToken: ${{ secrets.GITHUB_TOKEN }}
+
+  release:
+    uses: the-guild-org/shared-config/.github/workflows/release-snapshot.yml@main
+    with:
+      npmTag: alpha
+      buildScript: build
+      nodeVersion: 16
+    secrets:
+      githubToken: ${{ secrets.GITHUB_TOKEN }}
+      npmToken: ${{ secrets.NPM_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,15 @@
+name: Release
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  stable:
+    uses: the-guild-org/shared-config/.github/workflows/release-stable.yml@main
+    with:
+      releaseScript: release
+      nodeVersion: 16
+    secrets:
+      githubToken: ${{ secrets.GITHUB_TOKEN }}
+      npmToken: ${{ secrets.NPM_TOKEN }}

README.md

@@ -56,86 +56,31 @@ If you are ready to dive into the details of building a subgraph from scratch, t
 
 ## Release process
 
-The steps to create a new version of the `graph-cli` are:
+We use `changeset` to manage releases. Every PR should include a changeset file. The release process is as follows:
 
-1. Decide which version number you'll be rolling out. You can check the differences between the current `main` branch and the latest release.
-2. Create a PR with the commit generated by `npm version <VERSION> [<PREID>]`.
-3. Once that's approved and merged to `main`, you can publish it to `npm` and push the git tags as well.
-4. Last but not least, create a Github Release refering to the pushed git tag, linking to the PRs involved.
+1. Author creates the PR with changes and runs `pnpm changeset` to create a changeset file to summarize the changes.
+2. When the PR is merged to `main`, a Github Action will run and create a PR with the version bump and changelog.
+3. We will merge the bot generated PR to `main`.
+4. A Github Action will run and publish the new version to npm.
 
 Helpful links:
 
 - [Semver official docs](https://semver.org/)
-- [`npm version` docs](https://docs.npmjs.com/cli/v7/commands/npm-version)
-- [`npm publish` docs](https://docs.npmjs.com/cli/v7/commands/npm-publish)
-- [`npm unpublish` docs](https://docs.npmjs.com/cli/v7/commands/npm-unpublish)
-- [`npm deprecate` docs](https://docs.npmjs.com/cli/v7/commands/npm-deprecate)
+- [Changesets](https://github.com/changesets/changesets)
+- [Snapshot release](https://github.com/changesets/changesets/blob/main/docs/snapshot-releases.md)
 
-### Stable release example
-
-Current version: `0.34.9`.
-Desired release: `0.35.0`.
-
-To create the PR:
-```
-git checkout -b <BRANCH>
 
-npm version minor
-
-git push --set-upstream <REMOTE> <BRANCH>
-```
-
-Once that's approved and merged, you can update your local `main` and:
+### Stable release example
 
-```
-npm publish
+When PRs are merged and to `main` we can choose to merge the bot generated changeset PR to `main` and it will publish a new version to npm.
 
-npm push --tags
-```
+Example of a `graph-client` release: https://github.com/graphprotocol/graph-client/pull/295
 
 ### Alpha release example
 
-Current version: `0.29.2`.
-Desired release: `0.30.0-alpha.0`.
-
-To create the PR:
-```
-git checkout -b <BRANCH>
-
-npm version preminor --preid alpha
-
-git push --set-upstream <REMOTE> <BRANCH>
-```
-
-Once that's approved and merged, you can update your local `main` and:
+Every PR to `main` that includes a changeset file will create a new alpha version.
 
-```
-npm publish --tag alpha
-
-npm push --tags
-```
-
-### Alpha pre-release example
-
-Current version: `0.30.0-alpha.0`.
-Desired release: `0.30.0-alpha.1`.
-
-To create the PR:
-```
-git checkout -b <BRANCH>
-
-npm version prerelease --preid alpha
-
-git push --set-upstream <REMOTE> <BRANCH>
-```
-
-Once that's approved and merged, you can update your local `main` and:
-
-```
-npm publish --tag alpha
-
-npm push --tags
-```
+Example of `graph-client` snapshot release: https://github.com/graphprotocol/graph-client/pull/178#issuecomment-1214822036
 
 ## License
 

examples/basic-event-handlers/package.json

@@ -1,5 +1,6 @@
 {
   "name": "basic-event-handlers",
+  "private": true,
   "version": "0.1.0",
   "scripts": {
     "codegen": "../../packages/cli/bin/graph codegen",

examples/example-subgraph/package.json

@@ -1,5 +1,6 @@
 {
   "name": "example-event-handler",
+  "private": true,
   "scripts": {
     "codegen": "../../packages/cli/bin/graph codegen --output-dir src/types/ subgraph.yaml",
     "build": "../../packages/cli/bin/graph build subgraph.yaml",

package.json

@@ -2,6 +2,8 @@
   "name": "graphprotocol-tools-monorepo",
   "private": true,
   "devDependencies": {
+    "@changesets/changelog-github": "^0.4.7",
+    "@changesets/cli": "^2.25.2",
     "eslint": "6.8.0",
     "jest": "26.0.0"
   },
@@ -19,6 +21,7 @@
   },
   "scripts": {
     "build": "exit 0",
+    "release": "changeset publish",
     "test:cli": "pnpm --filter @graphprotocol/graph-cli test"
   }
 }

packages/cli/package.json

@@ -45,5 +45,8 @@
     "test": "jest --verbose",
     "test:init": "jest tests/cli/init.test.js --verbose",
     "test:validation": "jest tests/cli/validation.test.js --verbose"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }