feat: update github backup script to do all orgs that the user has access too

[venkatamutyala]

User description

feat: update github backup script to do all orgs that the user has access too

---

PR Type

enhancement

---

Description

• Updated the GitHub backup script to support backing up all organizations that a user has access to, instead of a single specified organization.
• Implemented pagination to handle fetching of all organizations in case of large numbers.
• Modified the backup process to iterate through each organization and backup their repositories.
• Improved logging to indicate the start and finish of each organization's backup process.

---

Changes walkthrough 📝

	Relevant files
Enhancement	github-backup.sh Enhance GitHub backup script to support multiple organizations github-backup.sh Removed single organization backup logic. Added logic to backup all organizations a user has access to. Implemented pagination to fetch all organizations. Enhanced backup process to iterate through multiple organizations. +44/-17

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 No relevant tests

🔒 Security concerns Sensitive information exposure: The script uses the GitHub token directly in the git clone URL (line 46). This could potentially expose the token if the script output is logged or if an error occurs during cloning. Consider using a more secure method to authenticate git operations, such as using the GIT_ASKPASS environment variable or the credential helper.

⚡ Recommended focus areas for review Potential Performance Issue The script fetches all organizations and then processes them sequentially. For users with access to many organizations, this could lead to long execution times. Consider implementing parallel processing for multiple organizations. Error Handling The script lacks proper error handling for API calls and git operations. Consider adding try-catch blocks or error checks to handle potential failures gracefully. Resource Management The script creates temporary directories and files but doesn't clean them up after use. Implement a cleanup mechanism to remove temporary files and directories after successful S3 upload.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible issue	Validate required environment variables before executing critical operations Add a check to ensure the S3_BUCKET_NAME environment variable is set before attempting to upload to S3. github-backup.sh [53] +if [[ -z "${S3_BUCKET_NAME}" ]]; then + echo "Error: S3_BUCKET_NAME is not set." + exit 1 +fi aws s3 cp --recursive github.com/ s3://${S3_BUCKET_NAME}/github.com/ Apply this suggestion Suggestion importance[1-10]: 9 Why: This suggestion adds an important check for the S3_BUCKET_NAME environment variable before attempting to upload to S3. This can prevent errors and potential data loss, making it a critical addition to the script.	9
	Implement error handling for API requests to improve script reliability Add error handling for the case when the GitHub API request fails or returns unexpected data. github-backup.sh [18] -orgs=$(gh api "/user/orgs?page=$page" --jq '.[].login') +if ! orgs=$(gh api "/user/orgs?page=$page" --jq '.[].login'); then + echo "Error: Failed to fetch organizations from GitHub API" + exit 1 +fi Apply this suggestion Suggestion importance[1-10]: 8 Why: This suggestion adds crucial error handling for the GitHub API request, which can significantly improve the script's reliability and help diagnose issues if the API call fails.	8
Best practice	✅ Improve script structure to avoid potential issues with variable scoping Suggestion Impact: The commit addresses the variable scoping issue by avoiding the use of a pipeline that creates a subshell. Instead of using `echo` with a pipeline, the commit uses positional parameters to handle the list of organizations, which aligns with the intention of the suggestion. code diff: -echo "Full list to be backed up: $orgs" +# Save the original IFS +OLD_IFS="$IFS" -echo "$all_orgs" | while IFS= read -r GITHUB_ORG_TO_BACKUP; do +# Set IFS to comma for splitting +IFS=',' +# Read the all_orgs into positional parameters +set -- $all_orgs + +# Restore the original IFS +IFS="$OLD_IFS" + +echo "Full list to be backed up: $all_orgs" + +for GITHUB_ORG_TO_BACKUP in "$@"; do Use process substitution instead of a pipeline to avoid creating a subshell, which can cause issues with variable scoping. github-backup.sh [35] -echo "$all_orgs" | while IFS= read -r GITHUB_ORG_TO_BACKUP; do +while IFS= read -r GITHUB_ORG_TO_BACKUP; do Apply this suggestion Suggestion importance[1-10]: 6 Why: The suggestion addresses a potential issue with variable scoping by avoiding the creation of a subshell. This can prevent unexpected behavior in the script, especially when dealing with variable assignments within the loop.	6
Enhancement	✅ Correctly display the list of organizations with proper formatting Suggestion Impact: The variable used in the echo statement was changed from $orgs to $all_orgs, as suggested. code diff: -echo "Full list to be backed up: $orgs" +echo "Full list to be backed up: $all_orgs" Use the -r option with echo to interpret backslash escapes correctly when printing the list of organizations. github-backup.sh [33] -echo "Full list to be backed up: $orgs" +echo -e "Full list to be backed up:\n$all_orgs" Apply this suggestion Suggestion importance[1-10]: 5 Why: The suggestion improves the readability of the output by using the -e option with echo to interpret backslash escapes. It also corrects the variable used from $orgs to $all_orgs, which is more accurate.	5

💡 Need additional feedback ? start a PR chat

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud