Skip to content

Commit

Permalink
updated for additional clarification in comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ldraney committed May 8, 2024
1 parent 95880ca commit f91f09c
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .github/scripts/actionUtils.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ const fs = require("fs"); // NodeJs module provides an API for interacting with
* This function is designed to be reused across different modules or scripts.
*
* @param {string} summaryContent The content to append to the GitHub step summary.
* @returns {Promise<void>} A Promise that resolves with no value (undefined) if the append operation succeeds,
* or rejects if an error occurs during the append operation.
*
*/
async function appendSummary(summaryContent) {
try {
Expand Down
3 changes: 2 additions & 1 deletion .github/scripts/createAndPostTag.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ const appendSummary = require("./actionUtils");
* @param {string} repo The repository name.
* @param {string} newVersion The new version for the tag.
* @param {string} sha The SHA of the commit to tag.
* @async
* @returns {Promise<void>} A Promise that resolves when the tag is successfully created and pushed,
* or rejects if an error occurs.
*/
async function createTag(github, owner, repo, newVersion, sha) {
const tagName = `${newVersion}`;
Expand Down
2 changes: 1 addition & 1 deletion .github/scripts/prData.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ function processLabelsAndVersion(labels, currentVersion) {
/**
* Main function to handle pull request data for a GitHub repository.
* @param {Object} params - Parameters including GitHub client and context.
* @returns {Object|null} - An object containing pull request processing results or null in case of error.
* @returns {Promise<Object>} - An object containing pull request processing results or null in case of error.
*/
async function prData(params) {
const { github, context, core } = params;
Expand Down
2 changes: 2 additions & 0 deletions .github/scripts/preTagSummary.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ const appendSummary = require("./actionUtils");
* @param {object} github - The GitHub context object, providing context like repo and owner.
* @param {object} context - The GitHub context object with additional pull request information.
* @param {object} core - The GitHub core library, used for setting action failure messages.
* @returns {Promise<void>} A Promise that resolves when the summary has been successfully appended,
* or rejects if an error occurs during the operation.
*/
async function preTagSummary(params) {
const { github, context, core } = params;
Expand Down

0 comments on commit f91f09c

Please sign in to comment.