Merge pull request #17 from rkalis/main

Split up release process into PR + release

.github/workflows/create-update-pr.yml

@@ -0,0 +1,29 @@
+name: Create Update PR
+on:
+  workflow_dispatch:
+  # Auto-update every week on midnight Monday
+  schedule:
+    - cron: '0 0 * * 1'
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies
+        run: yarn
+      - name: Generate new files
+        run: yarn generate && yarn build
+      - name: Update version (major if there are deletions in enums.ts, otherwise minor)
+        run: git diff src/enums.ts | grep "^-[^-]" && yarn version --major --no-git-tag-version || yarn version --minor --no-git-tag-version
+      - name: Commit and create PR
+        uses: peter-evans/create-pull-request@v5
+        with:
+          commit-message: Update chains based on latest data from chainId.network
+          title: Update chains based on latest data from chainId.network
+          body: Update chains based on latest data from chainId.network
+          branch: update-chains
+          delete-branch: true

.github/workflows/update.yml → .github/workflows/publish-release.yml

@@ -1,38 +1,28 @@
-name: Update
+name: Publish Release
 on:
   workflow_dispatch:
-  # Auto-update every week on midnight Monday
-  schedule:
-    - cron: '0 0 * * 1'
+  push:
+    branches:
+      - main
 jobs:
   update:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '12.x'
+          node-version: 16.x
           registry-url: 'https://registry.npmjs.org'
       - name: Install dependencies
         run: yarn
-      - name: Generate new files
-        run: yarn generate && yarn build
-      - name: Update version (major if there are deletions in enums.ts, otherwise minor)
-        run: git diff src/enums.ts | grep "^-[^-]" && yarn version --major --no-git-tag-version || yarn version --minor --no-git-tag-version
-      - name: Commit and push changes
-        uses: EndBug/add-and-commit@v9
-        with:
-          default_author: 'github_actions'
-          message: 'Update chains based on latest data from chainId.network'
       - name: Publish to npm
-        run: yarn publish
+        run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
       - name: Get package.json info
         id: package_json
         uses: jaywcjlove/github-action-package@main
       - name: Create Release
-        id: create_release
         uses: actions/create-release@latest
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,4 +1,4 @@
-[![Publish](https://github.com/taylorjdawson/eth-chains/actions/workflows/main.yml/badge.svg)](https://github.com/taylorjdawson/eth-chains/actions/workflows/main.yml) ![npm](https://img.shields.io/npm/v/eth-chains?logoColor=blue)
+[![Publish](https://github.com/taylorjdawson/eth-chains/actions/workflows/publish-release.yml/badge.svg)](https://github.com/taylorjdawson/eth-chains/actions/workflows/publish-release.yml/badge.svg) ![npm](https://img.shields.io/npm/v/eth-chains?logoColor=blue)
 
 # Eth Chains
 
@@ -14,6 +14,10 @@ yarn add eth-chains
 npm install eth-chains
 ```
 
+### Note on versioning
+
+`eth-chains` uses a weekly automated release script that updates its chain data. This release script takes breaking changes into account, so breaking changes (e.g. renamed chains) are released as a new major version, while non-breaking changes (e.g. new chains) are released as a new minor version.
+
 ## Usage
 
 Import `chains` methods and enums:
@@ -60,7 +64,7 @@ chains.getByName('Ethereum Mainnet')
 ### Get all Chains:
 
 ```ts
-const allChains = chains.all() 
+const allChains = chains.all()
 // { 1: { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }, 2: {...}}
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eth-chains",
-  "version": "3.0.0",
+  "version": "2.0.0",
   "description": "Helper module for getting Ethereum chains info.",
   "author": "Taylor Dawson",
   "main": "dist/index.js",