-
Notifications
You must be signed in to change notification settings - Fork 69
How to do changes to Oppiabot
Sean Lip edited this page Mar 27, 2023
·
3 revisions
-
You need to check whether your changes should be done in GitHub Actions code (actions folder) or in probot code (lib folder), depending on where the existing code currently lies. If you need to create a new file, do it using GitHub Actions.
- If you need to do your changes to GitHub Actions code you can see migration guide and it might help you to do your changes.
- If you need to do your changes to probot you should first check whether you can also migrate the feature to GH Actions and if yes then follow the migration guide.
- If it is not easy to migrate the feature you can just modify it. The common flow of probot is:
- In constants.js we have different events and checks that are executed when the event is triggered. Also in this file we assign different checks to different events for each repository. You first need to understand which check you want to modify.
- In index.js we have a code that calls different functions for different checks. So after you have identified the check you want to modify you can find the function that you need to modify here.
- The functions that you need to modify are in lib folder.
- After you have done your changes you should make sure to update the tests, you can find the instructions here.
-
After you've done your changes create PR, get it reviewed and merged.
-
After your PR is merged make sure that someone with deploy priviledges deploys your changes to production.