Get Fellows Action

GitHub action to fetch all the fellows information.

This action fetches all the fellows from the on-chain data and output two objects with the fellows data and with the users’ GitHub information.

It looks in the fellows data for a field named GitHub and it extracts the handle from there.

This action is intended to be chained with other actions that requires the fellows GitHub handles.

Installation

This action is intended to be chained with other actions. It does not have any requirements.

We simply need to add the step:

- uses: paritytech/get-fellows-action
  id: fellows

A working example where we print all the names is the following:

name: Mention fellows

on: [push]

jobs:
  mention-fellows:
    runs-on: ubuntu-latest
    steps:
      - uses: paritytech/get-fellows-action
        id: fellows
      - name: Mention them
        run: |
          echo "The fellows are $FELLOWS"
        env:
          # the handles of the fellows separated by commas
          FELLOWS: ${{ steps.fellows.outputs.github-handles }}"

Outputs

You can find all the outputs in the action.yml file.

They are:

• fellows: A JSON array with objects of type "address": "1e2345...", "rank": rank (as a number), “githubHandle”: “handle (can be null)”
  • Example: [{"address":"1e2345...",rank: 4, "githubHandle":"user-1"},{"address":"1e4532...",rank: 3, "githubHandle":"user-2"},{"address":"1e8335...",rank: 6}]
• github-handles: All the fellows handles separated by commas
  • Example: user-1,user-2,user-3

Deployment

To deploy a new version you need to update two files:

• package.json: Update the version number.
• action.yml: Update the image number in runs.image. Important: Both versions must have the same number.

When a commit is pushed to the main branch and the versions have changed, the system will automatically tag the commit and release a new package with such version.

You can find all the available versions in the release section.