kudos-ink/workflow-example

GitHub workflow to add in your project to let people contribute with automatic payments

Workflow example

This workflow will help you as an example when you want to integrate Kudos ink! in your repository. This workflow describes a simple case when the assignee of the issue will be "approved" to claim a reward in the smart contract as soon as the issue is closed. You can customize it and create more advanced workflows.

Approve action

The workflow must include this custom GitHub Action that will call the approve method of the contract. More information about the action here

Prerequisites

Organization

1. Create your smart contract follow the guidelines from our contracts repository.
2. Deploy it and instantiate it.

Contributors

1. Register yourself as a contributor in the smart contract provided by the organization you want to contribute using the method registerIdentity.

Steps

1. Copy the workflow file in your repository.
2. Create these configuration variables in your repository:
3. WS_PROVIDER_URL: the web-socket url of the parachain where the smart contract is placed
4. CONTRACT_ADDRESS: the address of the contract
5. ABI: the abi (JSON) of the contract
6. Create this secret in your repository:
7. MNEMONIC_PHRASE: mnemonic phrase of the account used when the contract was instantiated.

Usage

1. Create a new Issue with the label "payment".
2. Assign it to a contributor that wants to get a reward by solving the issue.
3. Close it when the work is done. This will trigger the workflow that will call the smart contract.
4. Optionally, check the workflow output.

Example

Issue closed

#22

Workflow triggered

https://github.com/kudos-ink/workflow-example/actions/runs/6685279925/job/18163413958

workflow-example's Issues

Test: again

Test

Example

This is an example

Test #1

Test: pr

Test: complex

Issue

Test: new contract without PR

Test

Test adding 0x in the sha256 result

Test: linked pr

Issue

Issue

Existing issue with a reward

Test: new contract

Fix

Test using issue id and hashed asignee

Test with payment

Test with hardcoded values in the contract call

Issue

Test: new workflow

Test

Test

Test: complex case

Test: with PR

Test: it won't trigger the contract call because it hasn't the payment label

Test:

Fixed Test: it won't trigger the call because there's no PR

Test: it won't trigger the call because there's no PR

Allow users to select a payable or non-payable issue template

Contributors can choose between payable or non-payable issues when they're creating a new one.

Payable issue:

• it may require some special fields (custom labels, address, etc)