- move pr collection into npm module

(publish without any furhter notes or docs)
- refactor action to use npm dependency

src/releaseNotesBuilder.ts

@@ -1,12 +1,12 @@
 import * as core from '@actions/core'
 import {Configuration} from './configuration'
-import {Octokit} from '@octokit/rest'
-import {TagInfo, Tags} from './tags'
-import {checkExportedData, failOrError} from './utils'
-import {HttpsProxyAgent} from 'https-proxy-agent'
-import {PullRequestInfo, PullRequests} from './pullRequests'
-import {Commits, DiffInfo} from './commits'
+import {checkExportedData} from './utils'
 import {buildChangelog} from './transform'
+import {PullRequestCollector} from 'github-pr-collector'
+import {failOrError} from 'github-pr-collector/lib/utils'
+import {TagInfo} from 'github-pr-collector/lib/tags'
+import {DiffInfo} from 'github-pr-collector/lib/commits'
+import {PullRequestInfo} from 'github-pr-collector/lib/pullRequests'
 
 export interface ReleaseNotesOptions {
   owner: string // the owner of the repository
@@ -22,12 +22,11 @@ export interface ReleaseNotesOptions {
   configuration: Configuration // the configuration as defined in `configuration.ts`
 }
 
-export interface ReleaseNotesData {
+export interface Data {
   diffInfo: DiffInfo
   mergedPullRequests: PullRequestInfo[]
   options: ReleaseNotesOptions
 }
-
 export class ReleaseNotesBuilder {
   constructor(
     private baseUrl: string | null,
@@ -69,77 +68,34 @@ export class ReleaseNotesBuilder {
       }
       core.endGroup()
 
-      // 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(
+      const prData = await new PullRequestCollector(
+        this.baseUrl,
+        this.token,
         this.repositoryPath,
         this.owner,
         this.repo,
         this.fromTag,
         this.toTag,
+        this.includeOpen,
+        this.failOnError,
         this.ignorePreReleases,
-        this.configuration.max_tags_to_fetch,
-        this.configuration.tag_resolver
-      )
+        this.fetchReviewers,
+        this.fetchReleaseInformation,
+        this.fetchReviews,
+        this.commitMode,
+        this.configuration
+      ).build()
 
-      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)
+      if (prData == null) {
         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 = {
+      const resolvedOptions = prData.options
+      const options: ReleaseNotesOptions = {
         owner: this.owner,
         repo: this.repo,
-        fromTag: previousTag,
-        toTag: thisTag,
+        fromTag: resolvedOptions.fromTag,
+        toTag: resolvedOptions.toTag,
         includeOpen: this.includeOpen,
         failOnError: this.failOnError,
         fetchReviewers: this.fetchReviewers,
@@ -148,8 +104,44 @@ export class ReleaseNotesBuilder {
         commitMode: this.commitMode,
         configuration: this.configuration
       }
+      const mergedPullRequests = prData.mergedPullRequests
+      const diffInfo = prData.diffInfo
 
-      releaseNotesData = await pullData(octokit, options, this.exportCollected, this.exportOnly)
+      // define the included PRs within this release as output
+      core.setOutput(
+        'pull_requests',
+        mergedPullRequests
+          .map(pr => {
+            return pr.number
+          })
+          .join(',')
+      )
+      core.setOutput('changed_files', diffInfo.changedFiles)
+      core.setOutput('additions', diffInfo.additions)
+      core.setOutput('deletions', diffInfo.deletions)
+      core.setOutput('changes', diffInfo.changes)
+      core.setOutput('commits', diffInfo.commits)
+
+      if (this.exportCollected) {
+        core.info('📦 Exporting collected data')
+        core.exportVariable(`RCBA_EXPORT_diffInfo`, JSON.stringify(diffInfo))
+        //fs.writeFileSync(path.resolve('diffInfo.json'), JSON.stringify(diffInfo))
+        core.exportVariable(`RCBA_EXPORT_mergedPullRequests`, JSON.stringify(mergedPullRequests))
+        //fs.writeFileSync(path.resolve('mergedPullRequests.json'), JSON.stringify(mergedPullRequests))
+        core.exportVariable(`RCBA_EXPORT_options`, JSON.stringify(options))
+        //fs.writeFileSync(path.resolve('options.json'), JSON.stringify(options))
+
+        if (this.exportOnly) {
+          core.endGroup()
+          return null
+        }
+      }
+
+      releaseNotesData = {
+        mergedPullRequests,
+        diffInfo,
+        options
+      }
     } else {
       core.info(`ℹ️ Retrieved previously exported collected data`)
 
@@ -196,66 +188,3 @@ export class ReleaseNotesBuilder {
     }
   }
 }
-
-export async function pullData(
-  octokit: Octokit,
-  options: ReleaseNotesOptions,
-  exportCollected: boolean,
-  exportOnly: boolean
-): Promise<ReleaseNotesData | 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
-  }
-
-  // define the included PRs within this release as output
-  core.setOutput(
-    'pull_requests',
-    mergedPullRequests
-      .map(pr => {
-        return pr.number
-      })
-      .join(',')
-  )
-  core.setOutput('changed_files', diffInfo.changedFiles)
-  core.setOutput('additions', diffInfo.additions)
-  core.setOutput('deletions', diffInfo.deletions)
-  core.setOutput('changes', diffInfo.changes)
-  core.setOutput('commits', diffInfo.commits)
-
-  if (exportCollected) {
-    core.info('📦 Exporting collected data')
-    core.exportVariable(`RCBA_EXPORT_diffInfo`, JSON.stringify(diffInfo))
-    //fs.writeFileSync(path.resolve('diffInfo.json'), JSON.stringify(diffInfo))
-    core.exportVariable(`RCBA_EXPORT_mergedPullRequests`, JSON.stringify(mergedPullRequests))
-    //fs.writeFileSync(path.resolve('mergedPullRequests.json'), JSON.stringify(mergedPullRequests))
-    core.exportVariable(`RCBA_EXPORT_options`, JSON.stringify(options))
-    //fs.writeFileSync(path.resolve('options.json'), JSON.stringify(options))
-
-    if (exportOnly) {
-      core.endGroup()
-      return null
-    }
-  }
-
-  core.endGroup()
-
-  return {
-    diffInfo,
-    mergedPullRequests,
-    options
-  }
-}