executablebooks / github-activity

Simple markdown changelogs for GitHub repositories
https://github-activity.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
49 stars 11 forks source link

If a pull request closes an issue, check that issue's title / tags to categorize the contribution #71

Open choldgraf opened 2 years ago

choldgraf commented 2 years ago

Context

We currently check for tags or metadata in titles for the pull request that was merged within a given window:

https://github.com/executablebooks/github-activity/blob/2851438e520354ed8dc1bf0c6782b03c2b89822e/github_activity/github_activity.py#L471-L484

However, many projects put more labeling / tagging effort into their issues rather than the pull requests that close them. For example, a PR might have no labels itself, but might close an issue labeled documentation.

Proposal

If a Pull Request doesn't contain any information that can be used to categorize it, but it does have an issue that it closes, then we should try to infer the "category" of the PR by looking at the issue's information.

Note on implementation

We can grab the pointer to a closing issue via the closingIssuesReferences graphql field. We can then use this to return the title and list of labels for that issue. Here's a rough query that does this for a generic pull requests query:

{
  viewer {
    pullRequests(
      first: 100
      states: CLOSED
      orderBy: {field: UPDATED_AT, direction: DESC}
    ) {
      nodes {
        closingIssuesReferences(first: 5) {
          edges {
            node {
              labels(first:10) {
                edges {
                  node {
                    id
                    name
                    url
                  }
                }
              }
              title
              url
            }
          }
        }
      }
    }
  }
}

Tasks and updates

No response