Skip to content

Commit

Permalink
chore: setup config
Browse files Browse the repository at this point in the history
  • Loading branch information
0x4007 committed Sep 25, 2023
1 parent 6f475d8 commit ea3245d
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 11 deletions.
79 changes: 73 additions & 6 deletions .github/ubiquibot-config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,73 @@
priceMultiplier: 1.5
# newContributorGreeting:
# enabled: true
# header: "Thank you for contributing to UbiquiBot! Please be sure to set your wallet address before completing your first task so that the automatic payout upon task completion will work for you."
# helpMenu: true
# footer: "###### Also please star this repository and [@ubiquity/devpool-directory](https://github.com/ubiquity/devpool-directory/) to show your support. It helps a lot!"
privateKeyEncrypted: ""
promotionComment: "<h6>If you've enjoyed your experience in the DevPool, we'd appreciate your support. Follow <a href='https://github.com/ubiquity'>Ubiquity on GitHub</a> and star <a href='https://github.com/ubiquity/devpool-directory'>this repo</a>. Your endorsement means the world to us and helps us grow!</h6><h6>We are excited to announce that the DevPool and UbiquiBot are now available to partners! Our ideal collaborators are globally distributed crypto-native organizations, who actively work on open source on GitHub, and excel in research & development. If you can introduce us to the repository maintainers in these types of companies, we have a special bonus in store for you!</h6>"

evmNetworkId: 100
priceMultiplier: 1
issueCreatorMultiplier: 3
maxConcurrentAssigns: 2
paymentPermitMaxPrice: 1000

disableAnalytics: true
commentIncentives: true
assistivePricing: true
registerWalletWithVerification: false

timeLabels:
- name: "Time: <1 Hour"
- name: "Time: <2 Hours"
- name: "Time: <4 Hours"
- name: "Time: <1 Day"
- name: "Time: <1 Week"

priorityLabels:
- name: "Priority: 1 (Normal)"
- name: "Priority: 2 (Medium)"
- name: "Priority: 3 (High)"
- name: "Priority: 4 (Urgent)"
- name: "Priority: 5 (Emergency)"

incentives:
comment:
elements:
code: 1
img: 0
h1: 1
h2: 1
h3: 1
h4: 1
h5: 1
h6: 1
li: 0.5
a: 1
blockquote: 0
i: 0
totals:
word: 0.1

commandSettings:
- name: start
enabled: true
- name: stop
enabled: true
- name: wallet
enabled: true
- name: payout
enabled: true
- name: multiplier
enabled: true
- name: query
enabled: true
- name: allow
enabled: true
- name: autopay
enabled: true
- name: ask
enabled: true
- name: review
enabled: true

enableAccessControl:
label: true
organization: true

openAITokenLimit: 8000
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Instead, it is recommended to make a copy of the `.env.example` file and replace

1. Go to the [UbiquiBot App Marketplace](https://github.com/marketplace/ubiquibot)
2. Choose a plan and install UbiquiBot on your repository
3. Congratulations! You can now use the UbiquiBot to manage your tasks.
3. Congratulations! You can now use UbiquiBot to manage your tasks.

To test the bot, you can:

Expand Down Expand Up @@ -150,13 +150,13 @@ You can, for example:

## How it works

Task bot is built using the [probot](https://probot.github.io/) framework so initially the bot is a github app. But thanks to the [probot/adapter-github-actions](https://github.com/probot/adapter-github-actions) you can also use the bot as a github action.
UbiquiBot is built using the [probot](https://probot.github.io/) framework so initially the bot is a github app. But thanks to the [probot/adapter-github-actions](https://github.com/probot/adapter-github-actions) you can also use the bot as a github action.

You can use the task bot as a [github app](https://github.com/marketplace/ubiquibot).
You can use UbiquiBot as a [github app](https://github.com/marketplace/ubiquibot).

When using as a github app the flow is the following:

1. Task bot is added to a repository as a github app
1. UbiquiBot is added to a repository as a github app
2. You run the bot "backend" (for example on your local machine)
3. Some event happens in a repository and the bot should react somehow (for example: on adding a time label to an issue the bot should add a price label)
4. Event details are sent to your deployed bot instance (to a webhook URL that was set in github app's settings)
Expand Down Expand Up @@ -197,7 +197,7 @@ Make sure you have your local instance of ubiquibot running.

## Architecture Overview

Task bot is built using the [probot](https://probot.github.io/) framework so initially the bot is a github app
UbiquiBot is built using the [probot](https://probot.github.io/) framework so initially the bot is a github app

<pre>
&lt;root&gt;
Expand Down

0 comments on commit ea3245d

Please sign in to comment.