Optimize PR Checking, Branch Handling, and Workflow Timing in contribute.py

[saksham-gera]

There are several inefficiencies in the current GitHub automation script that need to be optimized for better performance and reliability:

1. Inefficient Open PR Check (anyOpenPR)

• Currently, the script fetches all pull requests and iterates through them to find an open PR.

Suggested Fix: Use repo.get_pulls(state='open', head=BRANCH_NAME) instead to fetch only relevant PRs.

2. Creating Duplicate Branches

• The script checks if a branch exists by iterating through all branches, which is inefficient for large repositories.

Suggested Fix: Use repo.get_branch(BRANCH_NAME) and handle exceptions if the branch does not exist.

3. Inefficient PR Status Fetching (printPRStatus)

• The script finds the highest issue/PR number instead of retrieving the latest PR efficiently.

Suggested Fix: Use repo.get_pulls(state='open', sort='created', direction='desc') to fetch the latest PR.

4. Excessive time.sleep(4) Delay

• The script waits for 4 seconds before checking PR status, which is arbitrary and may be unnecessary.

Suggested Fix: Implement a retry mechanism with exponential backoff instead of using a static sleep time.

5. Non-Standard Exit Codes

• The script exits with exit(0) even in failure cases, which incorrectly signals success.

Suggested Fix: Use exit(1) for errors to properly indicate failure cases.

6. STUDY_NAME Should Be Replaced STUDY_NAME_PATH With In checkInputValidity()

[saksham-gera]

Hi @pradeeban ,
Please review these proposed fixes and let me know if I should proceed with solving this issue.

[pradeeban]

Hi @saksham-gera,
Excellent catches. Assigned the issue to you.

Regards,
Pradeeban.

[saksham-gera]

Hi @pradeeban , I’ve completed this on my end, but I’m having trouble testing the code. I think there’s no branch with the author’s name on concore-stories, and it’s saying authentication failed because of this.

[pradeeban]

Ok, we need to look at it carefully. I think it is looking for the concore-bot account. You can leave this on hold for a while. Thanks for alerting, @saksham-gera

[saksham-gera]

Okay, in the meantime, should I try creating a bot account with a forked repository on my own? If everything works perfectly there, the code should function correctly in concore-stories with the right bot token as well.

[pradeeban]

concore-studies. right? You could try to make your own bot account. Whatever you do, make sure to log/document it. It will be a great resource. Parteek implemented this feature, if I remember correctly. I should ask him how to rectify this.

[saksham-gera]

There were multiple issues in the code, which I have now corrected. Authentication is no longer failing, and the study is successfully being pushed to the author’s branch. I verified this by forking concore-studies and using the working bot account credentials. However, the PR is still not being created automatically, even in the previous code. I’ll create a separate issue to address this.