docs: change process for generating docblocks through actions (#6237)

This PR changes the original process of generating docblocks through actions. The process now is: 1. When a PR is merged for the branch `changeset-release/develop`, the docblock generator tool us used to generate docblocks for the changed files. The changed files are determined by retrieving all comments since the last release and the files in each of those commits. 2. If there are changes after using the docblock generator tool, a PR is opened in the branch `chore/generate-tsdocs`. 3. Once the `chore/generate-tsdocs` is merged, it triggers an action that generates the references for the docs. This changes the previous behaviour of generating references on a new release. Both actions (that runs the docblock generator tool and that generates references for the docs) can also be triggered manually. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2024-01-29 10:05:14 +02:00
parent 8f9a12c895
commit 96629f1916
10 changed files with 698 additions and 119 deletions
--- a/docs-util/packages/docblock-generator/src/classes/git-manager.ts
+++ b/docs-util/packages/docblock-generator/src/classes/git-manager.ts
@@ -0,0 +1,75 @@
+import { Octokit } from "octokit"
+
+type Options = {
+  owner?: string
+  repo?: string
+  authToken?: string
+}
+
+export class GitManager {
+  private owner: string
+  private repo: string
+  private authToken: string
+  private octokit: Octokit
+  private gitApiVersion = "2022-11-28"
+
+  constructor(options?: Options) {
+    this.owner = options?.owner || process.env.GIT_OWNER || ""
+    this.repo = options?.repo || process.env.GIT_REPO || ""
+    this.authToken = options?.authToken || process.env.GITHUB_TOKEN || ""
+
+    this.octokit = new Octokit({
+      auth: this.authToken,
+    })
+  }
+
+  async getCommitFilesSinceLastRelease() {
+    // list releases to get the latest two releases
+    const { data: release } = await this.octokit.request(
+      "GET /repos/{owner}/{repo}/releases/latest",
+      {
+        owner: this.owner,
+        repo: this.repo,
+        headers: {
+          "X-GitHub-Api-Version": this.gitApiVersion,
+        },
+      }
+    )
+
+    // get commits between the last two releases
+    const commits = await this.octokit.paginate(
+      "GET /repos/{owner}/{repo}/commits",
+      {
+        owner: this.owner,
+        repo: this.repo,
+        since: release.published_at || undefined,
+        per_page: 100,
+      }
+    )
+
+    // get files of each of the commits
+    const files = new Set<string>()
+
+    await Promise.all(
+      commits.map(async (commit) => {
+        const {
+          data: { files: commitFiles },
+        } = await this.octokit.request(
+          "GET /repos/{owner}/{repo}/commits/{ref}",
+          {
+            owner: this.owner,
+            repo: this.repo,
+            ref: commit.sha,
+            headers: {
+              "X-GitHub-Api-Version": this.gitApiVersion,
+            },
+          }
+        )
+
+        commitFiles?.forEach((commitFile) => files.add(commitFile.filename))
+      })
+    )
+
+    return [...files]
+  }
+}