DEV Community: Ashley Pean

How to Get All Issues Linked to a Pull Request

Ashley Pean — Sun, 31 Jul 2022 04:01:37 +0000

Intro

The Github API provides a lot of fluidity in being able to access and mutate data within git programmatically. Github provides developers with both a traditional REST API and a more modern GraphQL API to interact with. However because of the increased flexibility of GraphQL APIs, there is some functionality that is available in GraphQL that is not available in REST.

So today, we'll explore how to use Github's GraphQL API to find all issues linked to a pull request.

Note: This tutorial will be using node. Scroll to bottom for a TLDR;

Prerequisites

Have a personal access token created in Github. This a personal oAuth token that Github uses to verify what user you are and if you have permissions to access the data that you're requesting. If you do not have one, you can create one using the documentation here. Make sure to create the token with the following permissions: repo, workflow, user
Have a basic understanding of how GraphQL queries work. We'll go over the structure of the specific query needed in this article, but it helps to have that knowledge upfront

The Query

query getLinkedIssues(
  $repository: String!,
  $organizationOrOwner: String!,
  $prNumber: Int!,
  $maxIssues: Int!,
) {
  repository(number: $prNumber) {
    closingIssuesReference(first: $maxIssues) {
      nodes {
        number
        body
        title
      }
    }
  }
}

A breakdown of the query

query getLinkedIssues( 
  /*
    These are the params (or data points) needed to run the query
    Params with a bang operator (!) are required

    It includes: 
     - repository: name of the repository you're accessing
     - owner: name of the owner of the repository
     - prNumber: the number of the pull request who's issues you need 
     - maxIssues: the maximum number of issues that you would like returned
  */
  $repository: String!,
  $owner: String!,
  $prNumber: Int!,
  $maxIssues: Int!,
) {
  repository(number: $prNumber) {

    // All issues referenced in the PR with a closing prefix
    // Examples here: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
    closingIssuesReference(first: $maxIssues) {

      // Nodes represent the individual issues 
      nodes {

        // The data we want returned for each issue
        // Check out the Github GraphQL Explorer for a full list
        // https://docs.github.com/en/graphql/overview/explorer
        number
        body
        title
      }
    }
  }
}

Making the Request

There are a few libraries you can use to interact with the Github API client that give you the ability to interact with Github's GraphQL client. For the purpose of this tutorial we'll provide one example using octokit's node-based client.

If you'd like more control on the type of data you return back, feel free to check out Github's GraphQL Explorer. It's a great playground that allows you to practice (and execute) queries so you can get a feel of the full API.


import { graphql } from "@octokit/graphql";

const linkedIssuesQuery = `
query getLinkedIssues(
  $repository: String!,
  $owner: String!,
  $prNumber: Int!,
  $maxIssues: Int!,
) {
  repository(number: $prNumber) {
    closingIssuesReference(first: $maxIssues) {
      nodes {
        number
        body
        title
      }
    }
  }
}
`

/* NOTE: 
This function needs your personal access token
in order to authorize and execute the query. 

DO NOT COPY AND PASTE YOUR TOKEN DIRECTLY. 

Instead, I recommend keeping the token in a 
.env file and not committing it to your source code
*/

const getIssueData = async (myToken) => {
  const issueData = await graphql({
    query: linkedIssuesQuery,
    repository: [INSERT_REPO_NAME_HERE],
    owner:[INSERT_OWNER_HERE],
    prNumber: [INSERT_PR_NUMBER_HERE],
    maxIssues: [INSERT_MAX_ISSUES_HERE],
    headers: {
      // Include a space after the word bearer
      authorization: "bearer " + myToken,
    },
  });
}

TLDR;

query getLinkedIssues(
  $repository: String!,
  $organizationOrOwner: String!,
  $prNumber: Int!,
  $maxIssues: Int!,
) {
  repository(number: $prNumber) {
    closingIssuesReference(first: $maxIssues) {
      nodes {
        number
        body
        title
      }
    }
  }
}

How to Leverage Twitter as a Software Engineer

Ashley Pean — Sat, 28 May 2022 04:09:01 +0000

Joining the software engineering space as a new developer or keeping up with changes to the community while maintaining full-time responsibilities can be a really daunting task. Luckily, there are some very prominent platforms that make connecting to other developers easy. Today I want to talk about how you can level up your engineering career using Twitter.

There are 4 main ways I think using Twitter can help you grow as a technologist:

Personal Growth
Networking
Learning
Fun!

So let's get into it!

P.S. This is going to be a pretty long post, so scroll down for a nice TLDR;

Personal Growth

Since Twitter is basically a personal diary, it just makes sense to track your personal growth as a developer on the platform. It's a great way to be able to look back on how you've grown both as a person and an engineer and to see all the milestones and achievements you've crossed.

And I know that sharing your personal thoughts, goals, successes, and failures in a public space can be pretty scary. And it can feel pointless to shout into the void to your 10 followers (8 of which are bots). But on the days where you want to give up and just throw your computer into the sea, being able to look back and see how far you've come and to realize that you are exactly where you wished to be in the past will give you the strength to keep going.

Learning

One of my favorite parts of using Twitter is that every single user now has the ability to ingest an almost infinite amount of educational content passively.

No matter how obscure of a field you're interested in, there are always experts willing to provide knowledge that took them years, or even decades to accumulate. And you can gather all of that cumulative knowledge just at the flick of your thumb. Plus it's a great way stay in the loop with all of the new and upcoming changes in the tech industry!

A good technique for finding valuable accounts to follow is to use Twitter's Topic feature. By following certain topics, Twitter's algorithm will add tweets to your timeline from users who are prominent in the topic that you're interested in and expose you to some new people. By using the feature, I've now been exposed to so many big names in the industry. From CTO's, VP's, and senior engineers at almost every major tech company, to huge names in open-source work, and even to people who are just passionate about the work that they do and making the tech space a more friendly and open one.

Another similar tool is Twitter's list feature. A lot of people in the tech industry have taken the time to curate lists of people to follow in every industry in the tech space (cybersecurity, IT, blockchain, networking, etc.). And by following the lists that others have created, you can get direct access to the content from people on any list you decide to follow.

Networking

Another great advantage of using Twitter as an engineer (and probably the most valuable) is how easy it makes it to network with others. Whether you have 2 or 2000 followers, you still have the same ability as any other person to show off your skills and knowledge. And having a public, social repository of all your work can be very enticing to potential employers and non-technical recruiters.

Hiring Resources

There is a growing community of devs/ex-devs on Twitter who have created wonderful hiring resources on the platform. This is absolutely not an exhaustive list, but some notable ones are:

#TechIsHiring, a hashtag and account created by @Chad_R_Stewart
@DevStartupJobs, an account and website that posts jobs for small, midsized, and large tech startups
@DiversifyTechCo, an account and site that posts jobs by companies that are specifically looking to hire technologists from traditionally marginalized communities
@BTPipeline, a jobs board created by @ParissAthena - the creator of #BlackTechTwitter

And there are hiring boards available for just about every facet of technology out there (crypto, college grads, self-taught/bootcamp grads, non-technical tech roles, etc. )

How to Find Hiring Managers

And while all of these hiring resources are great, they can't catch every cool opportunity that's out there - only the ones that are willing to pay to get advertised. So another great tool I've used in the past is Twitter's Following feature.

Say for example that I'm super into Airbnb and it's my personal dream to work for that company. If I go to Airbnb's Twitter account - or their engineering account, I can then go through the list of who they're following. And a majority of the names on that list will be:

People who work(ed) for the company,
Prominent people who work in the same or a similar industry, or
Open source tooling/software that the company works with

Now before I say anything else I want to give a huge disclaimer. PLEASE DO NOT BE A CREEP OR HARASS ANYBODY. While you can find prominent people in the industry , at the end of the day, they are still people - not magical beings who can give you a free ride into your dream job or salary. Please be respectful and courteous at all times and remember that there is another human being on the other side of the screen.

That being said, if you are able to connect with people that are already in the industries you want to be in or just passively follow them along their journeys, they'll oftentimes post valuable insights about the work that they're doing, the culture of engineering for their specific team(s), and any jobs that are available on their team(s). These are also likely the people who will be conducting interviews, will be on hiring panels, or will be direct hiring managers. And you'll probably have a better chance reaching out to them directly than you would sending out a cold application through the jobs portal.

Fun!

And last, but definitely not least, social media is fun - or it can be. If you're careful to engage with others respectfully and you curate your feed to your specific tastes, you can find some really great people with great insights, some fantastic memes/TikTok's, some really enlightening conversations, and some international friends!

Yes, you may have to listen to grown adults argue about whether or not HTML is a programming language for the 100th time, but overall the Tech Twitter experience is a pretty great one!

And if you liked this post or learned anything, feel free to visit my feed and follow @ashleypeandev, hopefully I'll get to posting more engaging content soon.

TLDR;

It's a great resource to track your personal growth.
There's almost unlimited learning content.
There are tons of job boards/and recruiters on the hunt for people to fill roles that you can reach out to.
It's a great way to keep up with changes/people in the industry.
It's a great tool to reach out to senior technologists/domain-specific experts and to get direct access to people involved in the hiring process.
It's a fun time!