From 88afbbf710b12f4b0663eab4a5b958854eae0388 Mon Sep 17 00:00:00 2001 From: ldraney Date: Wed, 8 May 2024 14:28:42 -0600 Subject: [PATCH] updated with knowledge on promises and await and async --- .github/scripts/prData.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/scripts/prData.js b/.github/scripts/prData.js index 30ef1bb910..a805d26d6a 100644 --- a/.github/scripts/prData.js +++ b/.github/scripts/prData.js @@ -6,7 +6,7 @@ * @param {string} owner - The owner of the GitHub repository. * @param {string} repo - The repository name. * @param {string} sha - The commit SHA. - * @returns {Promise} - A promise resolving to the list of pull requests. + * @returns {list} - A list of pull requests */ async function fetchPullRequests(github, owner, repo, sha) { return await github.rest.repos.listPullRequestsAssociatedWithCommit({ @@ -21,7 +21,7 @@ async function fetchPullRequests(github, owner, repo, sha) { * @param {Object} github - The GitHub client instance. * @param {string} owner - The owner of the GitHub repository. * @param {string} repo - The repository name. - * @returns {Promise} - A promise resolving to the current release version. + * @returns {string} - A string of the current release version. */ async function getReleaseVersionValue(github, owner, repo) { const { data } = await github.rest.actions.getRepoVariable({ @@ -37,7 +37,7 @@ async function getReleaseVersionValue(github, owner, repo) { * @param {Object} github - The GitHub client instance. * @param {string} owner - The owner of the GitHub repository. * @param {string} repo - The repository name. - * @returns {Promise} - A promise resolving to the SHA of the latest commit on the release branch. + * @returns {string} - The SHA of the latest commit on the release branch. */ async function fetchReleaseBranchSha(github, owner, repo) { const { data } = await github.rest.repos.getCommit({