- move pr collection into npm module

(publish without any furhter notes or docs) - refactor action to use npm dependency
2023-06-03 11:22:52 +00:00
parent 4a9ea3cd6a
commit e7dc26611c
28 changed files with 3529 additions and 1808 deletions
@@ -0,0 +1,159 @@
+import * as core from '@actions/core'
+import {Configuration} from './configuration'
+import {Octokit} from '@octokit/rest'
+import {TagInfo, Tags} from './tags'
+import {failOrError} from './utils'
+import {HttpsProxyAgent} from 'https-proxy-agent'
+import {PullRequestInfo, PullRequests} from './pullRequests'
+import {Commits, DiffInfo} from './commits'
+
+export interface Options {
+  owner: string // the owner of the repository
+  repo: string // the repository
+  fromTag: TagInfo // the tag/ref to start from
+  toTag: TagInfo // the tag/ref up to
+  includeOpen: boolean // defines if we should also fetch open pull requests
+  failOnError: boolean // defines if we should fail the action in case of an error
+  fetchReviewers: boolean // defines if the action should fetch the reviewers for PRs - approved reviewers are not included in the default PR listing
+  fetchReleaseInformation: boolean // defines if the action should fetch the release information for the from and to tag - e.g. the creation date for the associated release
+  fetchReviews: boolean // defines if the action should fetch the reviews for the PR.
+  commitMode: boolean // defines if we use the alternative commit based mode. note: this is only partially supported
+  configuration: Configuration // the configuration as defined in `configuration.ts`
+}
+
+export interface Data {
+  diffInfo: DiffInfo
+  mergedPullRequests: PullRequestInfo[]
+  options: Options
+}
+
+export class PullRequestCollector {
+  constructor(
+    private baseUrl: string | null,
+    private token: string | null,
+    private repositoryPath: string,
+    private owner: string,
+    private repo: string,
+    private fromTag: string | null,
+    private toTag: string | null,
+    private includeOpen: boolean = false,
+    private failOnError: boolean,
+    private ignorePreReleases: boolean,
+    private fetchReviewers: boolean = false,
+    private fetchReleaseInformation: boolean = false,
+    private fetchReviews: boolean = false,
+    private commitMode: boolean = false,
+    private configuration: Configuration
+  ) {}
+
+  async build(): Promise<Data | null> {
+    // check proxy setup for GHES environments
+    const proxy = process.env.https_proxy || process.env.HTTPS_PROXY
+    const noProxy = process.env.no_proxy || process.env.NO_PROXY
+    let noProxyArray: string[] = []
+    if (noProxy) {
+      noProxyArray = noProxy.split(',')
+    }
+
+    // load octokit instance
+    const octokit = new Octokit({
+      auth: `token ${this.token || process.env.GITHUB_TOKEN}`,
+      baseUrl: `${this.baseUrl || 'https://api.github.com'}`
+    })
+
+    if (proxy) {
+      const agent = new HttpsProxyAgent(proxy)
+      octokit.hook.before('request', options => {
+        if (noProxyArray.includes(options.request.hostname)) {
+          return
+        }
+        options.request.agent = agent
+      })
+    }
+
+    // ensure proper from <-> to tag range
+    core.startGroup(`🔖 Resolve tags`)
+    const tagsApi = new Tags(octokit)
+    const tagRange = await tagsApi.retrieveRange(
+      this.repositoryPath,
+      this.owner,
+      this.repo,
+      this.fromTag,
+      this.toTag,
+      this.ignorePreReleases,
+      this.configuration.max_tags_to_fetch,
+      this.configuration.tag_resolver
+    )
+
+    let thisTag = tagRange.to
+    if (!thisTag) {
+      failOrError(`💥 Missing or couldn't resolve 'toTag'`, this.failOnError)
+      return null
+    } else {
+      core.setOutput('toTag', thisTag.name)
+      core.debug(`Resolved 'toTag' as ${thisTag.name}`)
+    }
+
+    let previousTag = tagRange.from
+    if (previousTag == null) {
+      failOrError(`💥 Unable to retrieve previous tag given ${this.toTag}`, this.failOnError)
+      return null
+    }
+    core.setOutput('fromTag', previousTag.name)
+    core.debug(`fromTag resolved via previousTag as: ${previousTag.name}`)
+
+    if (this.fetchReleaseInformation) {
+      // load release information from the GitHub API
+      core.info(`ℹ️ Fetching release information was enabled`)
+      thisTag = await tagsApi.fillTagInformation(this.repositoryPath, this.owner, this.repo, thisTag)
+      previousTag = await tagsApi.fillTagInformation(this.repositoryPath, this.owner, this.repo, previousTag)
+    } else {
+      core.debug(`ℹ️ Fetching release information was disabled`)
+    }
+
+    core.endGroup()
+
+    const options = {
+      owner: this.owner,
+      repo: this.repo,
+      fromTag: previousTag,
+      toTag: thisTag,
+      includeOpen: this.includeOpen,
+      failOnError: this.failOnError,
+      fetchReviewers: this.fetchReviewers,
+      fetchReleaseInformation: this.fetchReleaseInformation,
+      fetchReviews: this.fetchReviews,
+      commitMode: this.commitMode,
+      configuration: this.configuration
+    }
+
+    return await pullData(octokit, options)
+  }
+}
+
+export async function pullData(octokit: Octokit, options: Options): Promise<Data | null> {
+  let mergedPullRequests: PullRequestInfo[]
+  let diffInfo: DiffInfo
+
+  const commitsApi = new Commits(octokit)
+  if (!options.commitMode) {
+    core.startGroup(`🚀 Load pull requests`)
+    const pullRequestsApi = new PullRequests(octokit, commitsApi)
+    const [info, prs] = await pullRequestsApi.getMergedPullRequests(options)
+    mergedPullRequests = prs
+    diffInfo = info
+  } else {
+    core.startGroup(`🚀 Load commit history`)
+    core.info(`⚠️ Executing experimental commit mode`)
+    const [info, prs] = await commitsApi.generateCommitPRs(options)
+    mergedPullRequests = prs
+    diffInfo = info
+  }
+  core.endGroup()
+
+  return {
+    diffInfo,
+    mergedPullRequests,
+    options
+  }
+}