added documentation, SiteIntegrationAPI #568
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
[diff-counting] Significant lines: 38. |
andrew032011
requested changes
Dec 3, 2023
andrew032011
approved these changes
Dec 3, 2023
|
@andrew032011 I would also really suggest not documenting this file for the sake of adding documentation. |
henry-li-06
reviewed
Dec 4, 2023
| @@ -5,6 +5,12 @@ import { PermissionError, BadRequestError } from '../utils/errors'; | |||
|
|
|||
| require('dotenv').config(); | |||
|
|
|||
| /** | |||
| * Triggers a dispatch event to pull changes from the IDOL backend. | |||
There was a problem hiding this comment.
I'd be a little more specific about what this does.
e.g. Triggers a dispatch event for the pull-from-idol GitHub action. This job (blah blah blah brief description of what the job does).
| export const getIDOLChangesPR = async (user: IdolMember): Promise<{ pr: PRResponse }> => { | ||
| await checkPermissions(user); | ||
| const foundPR = await findBotPR(); | ||
| return { pr: foundPR }; | ||
| }; | ||
|
|
||
| /** | ||
| * Accepts and merges the IDOL backend changes pull request. |
There was a problem hiding this comment.
This should mention what happens when the PR is merged (i.e. triggering a deploy).
| @@ -59,6 +77,12 @@ export const acceptIDOLChanges = async ( | |||
| return { pr: foundPR, merged: acceptedPR.data.merged }; | |||
| }; | |||
|
|
|||
| /** | |||
| * Rejects and closes the IDOL backend changes pull request. | |||
There was a problem hiding this comment.
Suggested change
| * Rejects and closes the IDOL backend changes pull request. | |
| * Closes the IDOL backend changes pull request. |
| * @param {IdolMember} user - The user attempting to reject the changes. | ||
| * @returns {Promise<{pr: PRResponse; closed: boolean}>} - A promise that resolves to an object containing the pull request details and a boolean indicating if the rejection was successful. | ||
| * @throws {PermissionError} - If the user lacks permission to reject the pull request. | ||
| */ |
There was a problem hiding this comment.
Also throws a BadRequestError if no PR is found.
|
@kevinmram doing some cleanup here to this PR doesn't get stale/abandoned. Let's either close this PR, or address these comments? |
oscarwang20
pushed a commit
that referenced
this pull request
May 6, 2024
* added documentation, SiteIntegrationAPI * added docstring, rejectIDOLChanges * added/edited suggested changes, prettier. * yarn install, prettier
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
added documentation to SiteIntegrationAPI- documenting the purpose and usage of each method within the class.