Display an overview of a GitHub Pull Request, including a timeline of key events

github-pr-overview

@alfie/github-pr-overview

https://api.github.com/repos/blockprotocol/blockprotocol/contents/{+path}

MIT License

blockprotocol

This PR converts `camelCase` website URLs to `kebab-case` ones. This better aligns them with web standards and reduces codebase entropy in the long term. For example, `/api/uploadUserAvatar` is now `/api/upload-user-avatar`.

I have also configured [`unicorn/filename-case`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/filename-case.md) for the affected folders to make sure we keep the entropy low.

area: dependencies

Area: relates to the site at blockprotocol.org

area: site

Area: relates to version control, CI, CD or IaC

area: infra

Switch to kebab-case in site URLs

https://api.github.com/repos/hashintel/hash/contents/{+path}

Data management, integration and modeling with blocks #

Other

hash

## 🌟 What is the purpose of this PR?

Adds a block for visualising GitHub PRs.

## 🔗 Related links

- #503 (Related)

## 📜 Does this require a change to the docs?

- Not to my knowledge

## ⚠️ Known issues

- The HASH app fails to load the block from `yarn dev` but succeeds with `yarn serve`
- The block currently resolves all entities by itself, rather than relying on links in the ontology (e.g. it looks up and filters IssueEvents rather than looking for ones **linked** to a PR)
- The block relies on the three entity types being available within the embedding application and finds them by expecting their titles to be `GithubPullRequest`, `GithubReview` and `GithubIssueEvent` respectively. This is necessary until types have URIs or other identifiers.

## 🐾 Next steps

- Iterate on the design
- Resolve entities through links
- Identify EntityTypeIds through a better mechanism

## 🛡 What tests cover this?

- None to my knowledge

## ❓ How to test this?



### Seeding the data
- checkout `am/source-github` (#503)
- Follow instructions of (#503) in **How to test this?** up until the mutations
- Run mutations:
  - `executeGithubCheckTask` - this confirms that it’s working and that your authentication token is good
  - executeGithubDiscoverTask - this queries for the available datastreams and generates the types within your workspace
  - It is possible that this will get angry about folder structure
- Edit the packages/hash/task-executor/src/tasks/source-github/secrets/catalog.json to only contain the JSON objects with the following stream names: `pull_requests`, `reviews`, `issue_events`
- Run the executeGithubReadTask mutation, probably with a timestamp of a few days
  - Go grab a coffee (it’s only a few minutes, there are some logs in the task-executor process that will say it received messages, and then how many records it found
### Testing the Block
- Swap branch back to `am/github-pr-overview-block`
- In blocks/github-pr-overview run yarn build && yarn serve (the yarn dev command seems broken 🙃 )
- Test block as normal

## 📹 Demo
<img width="653" alt="image" src="https://user-images.githubusercontent.com/25749103/165919623-b7d49d71-cd0e-4af3-8f65-d3be62834d70.png">
<img width="965" alt="image" src="https://user-images.githubusercontent.com/25749103/165919455-1d4482f2-db57-47e6-810b-0fd9694a994f.png">
<img width="602" alt="image" src="https://user-images.githubusercontent.com/25749103/165919511-7c53757d-6d95-4263-9fec-5d3d0959cd1e.png">
<img width="707" alt="image" src="https://user-images.githubusercontent.com/25749103/165919487-795f0765-baa7-41fc-a6c0-cafc3866aa6a.png">

Category: Pull requests that update a dependency file

C-dependencies

A-blocks

Add GitHub PR Overview block

Block Configuration Menu Updates (#524)

## 🌟 What is the purpose of this PR?



Currently the Block Config Menu doesn't
1. properly handle changes to properties of type "number". changes to properties get saved as a string even though the property type is a number
1. handle displaying input for properties that can either be a number or string. i.e properties with type ["number", "string"]

I noticed this when working on #515 . This PR fixes both issues 

## 🔗 Related links





- [Asana task](link) _(internal)_

## 🚫 Blocked by




- [ ] ...

## 🔍 What does this change?




- Update `updateProperty` to properly handle changes when the property type is "number" or ["number", "string"]
- Render an input when the property type is an array that contains "number"

## 📜 Does this require a change to the docs?



- No

A-hash

frontend

Block Configuration Menu Updates

Code looks good, tested and all pages / functionality working

GithubIssueEvent

GithubPullRequest

GithubReview

displays channel from https://ltst.xyz and stores the update in the embedding application

latest

Write titles, sub-titles, and section headings in four different sizes

heading

For the largest (top-level) section headings

Heading 1

Heading 2

Heading 3

Heading 4

Draw attention to an important point or message with framed text and a custom icon

callout

The Beta Launch

countdown

Write a block of text to express an idea, make a point, or record a thought

William Shakespeare was an English playwright, poet and actor, widely regarded as the greatest writer in the English language and the world's greatest dramatist. He is often called England's national poet and the "Bard of Avon".

paragraph

Display and manipulate tabular data with filter, sort, and search features

My Table

Full Name

Role

table

Set a countdown timer to remind you when a certain amount of time has elapsed

timer

Display information about a person, including their name, job title, email, website address, and an avatar

Bain & Co.

Archibald Adams-Montgomery

person

Embed JPG, GIF, and PNG images by URL or file upload and add an optional caption

image

Embed MP4 and WEBM videos by URL or file upload and add an optional caption

video

Create a list and (re-)arrange it in a random order

shuffle

Write monospaced code with syntax highlighting in a range of programming and markup languages

function debounce(func, timeout = 300){
  let timer;
  return (...args) => {
    clearTimeout(timer);
    timer = setTimeout(() => { func.apply(this, args); }, timeout);
  };
}

code

Generate blog posts, press releases, ad copy – using the power of AI

ai-text

Generate any image you can put into words, in just a few seconds

ai-image

Search for an address using the Mapbox Address Autofill and Mapbox Static Images APIs

address

Describe a task or process via a list of steps

Bring the clear water to a rolling boil for 1 minute

Boil water

how-to

Break up content on a page with horizontal dividing lines

divider

Describe a task or process via a list of steps 

stopwatch

Capture information in cards, and drag cards flexibly between customizable columns

GitHub Pull-Request Overview

GitHub Pull Request Overview block

Entity Data

Repository

Explore more blocks

Ready to build your own blocks?

Anyone can contribute