Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 2.05 KB

RELEASE.md

File metadata and controls

25 lines (20 loc) · 2.05 KB
Raw

Releasing circles-subgraph

Use this checklist to create a new release of circles-subgraph and deploy the subgraph to the official The Graph node. All steps are intended to be run from the root directory of the repository.

Creating a new release

  1. Make sure you are currently on the main branch, otherwise run git checkout main.
  2. git pull to make sure you haven’t missed any last-minute commits. After this point, nothing else is making it into this version.
  3. Read the git history since the last release, for example via git --no-pager log --oneline --no-decorate v1.0.0^..origin/main (replace v1.0.0 with the last published version).
  4. Condense the list of changes into something user-readable and write it into the CHANGELOG.md file with the release date and version, following the specification here on how to write a changelog. Make sure you add references to the regarding PRs and issues.
  5. Commit the CHANGELOG.md changes you've just made.
  6. Create a git and npm tag based on semantic versioning using npm version [major | minor | patch].
  7. git push origin main --tags to push the tag to GitHub.
  8. git push origin main to push the automatic package.json change after creating the tag.
  9. Create a new release on GitHub, select the tag you've just pushed under "Tag version" and use the same for the "Release title". For "Describe this release" copy the same information you've entered in CHANGELOG.md for this release. See examples here.

Deploy subgraph on "The Graph" node

  1. Go to your "The Graph" dashboard at https://thegraph.com/hosted-service/dashboard.
  2. Copy your Access Token from the dashboard (or ask someone in the team).
  3. Then you can prepare the configuration for the .env-xdai files by running: 
    npm run prepare:xdai
  4. Run npm run codegen, npm run build and npm run deploy to deploy the subgraph.