paritytech / paritytech/research

Plan a news bot which listens to commit messages from research repo and generate news note on the research website if the commits start with word "Major: "

Open
#42 2 comments 0 reactions 2 assignees View on GitHub

@drskalman is already working on this.

Since Jul 2, 2019.

enhancement
Dominant language
JavaScript
Stars
103
Forks
48
Avg merge
1h 25m
Merged PRs (30d)
1

Description

This was discussed during the retreat. This is my proposal, maybe it can be done simpler, maybe Makeadoc already has something for it but if not this is one way of doing it:

  • The bot should run somewhere (where?) listen on some port for github hook event and needs read and write access to the research repo. (It should be defined as an OAuth or Github app)

    • The bot should be called by the commit comment webhook:
      https://developer.github.com/v3/activity/events/types/#commitcommentevent

    • When the bot receives the POST request from github, it

    • check if its body have word "Major: "

    • pull the research repo.

    • delete the last line from research/doc/news.md.

    • drop "Major: " and add the rest of the commit as the first line.

    • Push to the research repo.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.