Created base action #1
Conversation
Bullrich
force-pushed
the
fellow-action
branch
from
0ad5bf6
to
5ce1c24
Compare
|
|
||
| type FellowData = { address: string; rank: number }; | ||
|
|
||
| export const fetchAllFellows = async ( |
There was a problem hiding this comment.
This functionality was copied from review-bot/fellows.ts
README.md
Outdated
| - `fellows-handles`: A JSON array with all the fellows GitHub handles | ||
| - Example: `["user-1","user-2","user-3"]` | ||
| - `fellows-map`: A JSON array with objects of type "user": "github-handle", "rank": rank (as a number) | ||
| - Example: `[{"user":"user-1",rank: 4}, {"user":"user-2",rank: 2}, {"user":"user-3",rank: 1}]` |
There was a problem hiding this comment.
it's currently mostly about mapping to GH handles, but it could potentially be used in more places and not only using github handles? like mapping their other identity data for sending notifications like email, right?
so im thinking how 'user' would describe that it's a GH username?
may be fellows-identity-map? idk..
There was a problem hiding this comment.
I will rename this field to be github related so we can do as you suggested in the other comment. Good idea!
| logger.debug("Connecting to collective parachain"); | ||
| // we connect to the collective rpc node | ||
| const wsProvider = new WsProvider( | ||
| "wss://polkadot-collectives-rpc.polkadot.io", |
There was a problem hiding this comment.
do we want later to add more chains besides polkadot/collectives?
There was a problem hiding this comment.
I would say no for now.
If we want, we can create an input type and set it there, but let's not over engineer it right now (as the modification would be simple if we actually need it)
src/index.ts
Outdated
| return { user: name, rank }; | ||
| }); | ||
| setOutput("fellows-map", JSON.stringify(fellowsMap)); | ||
| setOutput("fellows", fellowsHandles.join(",")); |
There was a problem hiding this comment.
imo the action name get-fellows-action sounds to me that it gives just fellow's addresses and ranks maximum.. then when we map it to identity, the identity by itself also consists of many other fields besides Github and if we make it as generic action, it could potentially be re-used somewhere else besides review-bot? but the output assumes the only thing user would need is list of github usernames separated by comma..
i don't know if any other app besides review-bot would benefit from that
or if would benefit - then fellows sounds a bit too broad? or a bit vague in terms of expectations of what kind of data will be there - addresses? or addresses + rank, or full identity map etc
may be it makes sense to provide just one fellows array of objects which complete address,rank,identity data objects? and then consumer converts to any kind of form, whether array of GH handles or anything else
wdyt?
There was a problem hiding this comment.
I like that idea, I'll change the current fellows to be fellows-github-handles. Makes more sense
Now the naming makes more sense and it is clearer
Created the core action to output the fellows GitHub handle.
This action is intended to be used with other actions that needs it (like
paritytech/auto-merge-botin the runtimes repository).