Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 2.89 KB

README.md

File metadata and controls

52 lines (37 loc) · 2.89 KB
Raw

rp-bounty

GitHub Actions Workflow Status GitHub Actions Workflow Status

This is a static site bounty portal that pulls data from a github repository of Rocket Pool bounty data maintained by the Rocket Pool Grants Management Committee.

Data Flow

Data is pulled into this repository via a periodic github action and a git submodule. The submodule mirrors the content of the GMC data repository.

The periodic action:

  • Sync and Updates the submodule.
  • Copies data from the submodule folder into the appropriate folders that are read by jekyll.
  • Pulls RSS data from the rocket pool forum.
  • Updates the USD/RPL price information from chainlink contracts via infura.

The github pages build is triggered automatically by changes in the source data.

Source Assumptions

  • That the maintainer will be notified if the skillset set changes. If a new skillset is added in the source data that is not currently present, it will not have a unique icon, but will otherwise behave correctly.
  • That the maintainer will be notified if the status set changes. If a new status is added in the source data that is not currently present, it will display without an icon with a black background.
  • That the dates.yml source data will be kept up-to-date. If not, the countdowns in the top right of the page will not display correctly.

To Maintain Bounty Content

  1. Make a PR with changes to the data respository, located here.
  2. Have changes reviewed by another person.
  3. Merge changes in data repository.
  4. Trigger data-update action in frontend repository, located here. Alternatively, wait for 24 hour periodic update.
  5. Confirm that data-update action in frontend repository succeeded and changes were merged.
  6. Confirm that pages-build-deployment action in frontend repository, located here was triggered (automatic) and succeeded.

You can use the hidden /admin page to view bounties with some extra information that may be useful for administration work.

Local Development

Follow these steps to setup a local server:

  1. Fork the repo
  2. Clone it locally
  3. Install dependencies: bundle install
  4. Start the local server: bundle exec jekyll serve
  5. Go to http://localhost:4400/ to view changes

To build the site use bundle exec jekyll build.

Notes:

  • You want Ruby version 2.7 rather than 3+

Resources: