@chainlink/external-adapter-framework 0.0.12 → 0.0.15

package/.eslintignore

@@ -7,3 +7,4 @@ coverage
 
 .yarn
 .vscode
+webpack.config.js

package/.github/README.MD

@@ -1,15 +1,40 @@
 # Github workflows for EAv3 Framework
 
-**Please note that this work is in progress. The README may not be accurate**
-
-## Overview
-This directory contains a basic GitHub workflow that builds, tests, and ultimately publishes the EAv3 Framework to NPM
-1. Setup (caches dependencies to speed up other steps)
-2. Build/Prepare/Preflight (all the following happen at the same time)
-   1. yarn build => publish artifact of build
-   2. yarn lint
-   3. yarn test
-3. Publish (currently unimplemented)
+**Please note that this work is in progress. The README may not be kept up to date as the CI process changes. This message will be removed when we're somewhat stable.**
+
+## Actions
+### setup
+Runs yarn install, then yarn build. Split into an action to avoid boilerplate in jobs.
+
+## Workflows
+
+### main
+Builds, tests, and lints the code. Triggered by any pull request action or a push on the master branch.
+
+### label
+
+Adds a label to a PR based on the branch name, and adds a label instructing `npm version` how to bump the version number.
+
+Labels are applied automatically only when a PR is opened. If it applies the wrong label (ex: your improvement is a minor ver, or some PR is a major ver), you can fix it by hand
+
+#### Label mappings:
+
+| Branch Prefix | Resulting label(s)             | Version bump |
+| --- |--------------------------------|--------------|
+| release | release, major | major |
+| feature/ | feature, minor                 | minor        |
+| bugfix/ | bugfix, patch                  | patch        |
+| hotfix/ | hotfix, patch                  | patch        |
+| fix/ | hotpix, patch | patch |
+| chore/ | chore, patch | patch |
+| improvement/ | improvement, patch             | patch        |
+| documentation/ | documentation, no-version-tick | none         |
+| noop/ | no-version-tick                | none         |
+
+### publish
+Bumps the version number based on the label if present, then builds and publishes the package to NPM.  This step is skipped if the change doesn't result in a version bump.
+
+This action **requires** any engineer to approve it.
 
 ### Some steps that still need to be added in:
 1. Check that changelog has an entry matching the current version in package.json

package/.github/workflows/label.yaml

@@ -0,0 +1,39 @@
+# Adds labels to pull requests based on the branch name. Labels are required by the "publish" workflow to determine
+name: 'Labels'
+on:
+  pull_request:
+    # TODO below is commented temporarily for testing
+#    types:
+#    - opened
+
+jobs:
+  publish: # Load the dependencies cache for all jobs
+    runs-on: ubuntu-latest
+    environment: main
+    steps:
+      - uses: actions/checkout@v3
+      - name: Calculate labels
+        id: calc-labels
+        run: | 
+          echo "Calculating labels based on branch: ${{ github.head_ref }}
+          HR=${{ github.head_ref }}
+          if [[ $hr == "improvement/*"  ]]; then
+            run: echo '::set-output name=LABELS::"improvement, patch"'
+          elif [[ $hr == "feature/*"  ]]; then
+            run: echo '::set-output name=LABELS::"feature, minor"'
+          elif [[ $hr == "bugfix/*"  ]]; then
+            run: echo '::set-output name=LABELS::"bugfix, patch"'
+          elif [[ $hr == "hotfix/*"  ]]; then
+            run: echo '::set-output name=LABELS::"hotfix, patch"'
+          elif [[ $hr == "release/*"  ]]; then
+            run: echo '::set-output name=LABELS::"release, major"'
+          elif [[ $hr == "chore/*"  ]]; then
+            run: echo '::set-output name=LABELS::"chore, patch"'
+          elif [[ $hr == "docs/*"  ]]; then
+            run: echo '::set-output name=LABELS::"docs, noop"'
+          else
+            run: echo '::set-output name=LABELS::"FIXME"'
+          fi
+      - uses: andymckay/labeler@master # Used in the official docs
+        with:
+          add-labels: ${{ steps.calc-labels.outputs.LABELS }}

package/.github/workflows/publish.yaml

@@ -12,9 +12,6 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/actions/setup
-      - run: yarn build
-      - run: cp package.json dist/src/
       - run: npm publish --access restricted #scoped packages are restricted by default, but this is set because not all branches currently have a scoped package name
-        working-directory: dist/src
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}