Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #336: provided a clear description of where to add the repo name in the constants.js file. #340

Merged
merged 4 commits into from
Dec 11, 2024

Conversation

Flying-Pegasus
Copy link
Contributor

Explanation

Updated the 'Installing the Bot on a Repository' section,
Added the bulletpoints to show step by step process.

The new lines I have added :
3. Added the repository name in the constants.js file:

  • Open the constants.js file in the bot's source code.
  • Navigate to the checksWhitelist object.
  • Add a new entry with your repository name (in lowercase) as the key. The value should define the checks and events specific to your repository.

Example:
If your repository name is my-repo, the checksWhitelist object will look like this:

const checksWhitelist = {
  // Existing entries...
  'my-repo': {
    [openEvent]: [claCheck],
    [reopenEvent]: [],
    [openEventGithubActions]: [claCheckGithubAction],
    [reopenEventGithubActions]: [claCheckGithubAction],
    [synchronizeEvent]: [mergeConflictCheck],
    [closeEvent]: [allMergeConflictCheck],
    [editEvent]: [],
    [issuesLabelEvent]: [],
    [issuesAssignedEvent]: [],
    [pushEvent]: [],
    [pullRequestReviewEvent]: [pullRequestReviewCheck],
    [issueCommentCreatedEvent]: [respondToReviewCheck],
  },
};

4.Save the changes to constants.js.

Checklist

  • I have successfully deployed my own instance of Oppiabot.
    • You can find instructions for doing this here.
  • I have manually tested all the changes made in this PR following the manual tests matrix.

Provided a clear description of where to add the repo name in the constant.js file.
corrected constant.js to constants.js
Solved the changes raised by the maintainer
@Flying-Pegasus
Copy link
Contributor Author

@seanlip I have updated the PR according to the norms. Please review again. Thank you

@seanlip seanlip changed the title Fix issue #336: provided a clear description of where to add the repo name in the constants.js file. Fix #336: provided a clear description of where to add the repo name in the constants.js file. Dec 10, 2024
1. Identify a target repository and install the bot by clicking the Install button on the settings page of your app, e.g., **`https://github.com/settings/apps/my-oppiabot-testing-app/installations`**
2. Update the **`.env` file**:
- Add your GitHub account name to `WHITELISTED_ACCOUNTS`.
3. Add the repository name in the **`constants.js` file**:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a blank line above "3." and above "2.", similar to how you have a space between sections 3. and 4.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2024-12-10 185802

@seanlip will this work?

Added line above point 2 and 3 in the "Installing the bot on a repository" section
Copy link
Member

@seanlip seanlip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks!

@seanlip
Copy link
Member

seanlip commented Dec 10, 2024

(And congrats on your first PR to Oppia!)

@oppiabot oppiabot bot added the PR: LGTM label Dec 10, 2024
Copy link

oppiabot bot commented Dec 10, 2024

Hi @Flying-Pegasus, this PR is ready to be merged. Please address any remaining comments prior to merging, and feel free to ask someone to merge your PR once the CI checks pass and you're happy with it. Thanks!

@Flying-Pegasus
Copy link
Contributor Author

Flying-Pegasus commented Dec 10, 2024

Thank you @seanlip for guiding me. Looking forward to solve more issues. Please merge the PR.

@seanlip seanlip merged commit 0dd314c into oppia:master Dec 11, 2024
3 checks passed
@Flying-Pegasus Flying-Pegasus deleted the updating-readme.md branch December 11, 2024 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants