Skip to content

Conversation

@riverma
Copy link
Collaborator

@riverma riverma commented Jun 3, 2025

Purpose

Update the GitHub Security Best Practices guide to reflect the current GitHub security settings interface and features. This PR modernizes the documentation to match the latest GitHub UI, adds automation script integration, and removes outdated references to ensure users have accurate, actionable guidance for securing their repositories.

Proposed Changes

  • [ADD] GitHub Security Settings automation script
  • [CHANGE] GitHub security settings guide with updated content to reflect new script
  • [REMOVE] Outdated GitHub security feature descriptions that no longer match the current interface

Issues

Testing

  • Tested on local docusaurus instance successfully
  • Tested script successfully on github.com/riverma/test-repo

@riverma riverma self-assigned this Jun 3, 2025
@riverma riverma added most requested Highly requested by community members software lifecycle Process improvements involving developing, testing, integrating, deploying software website Improvement / fix to the SLIM website labels Jun 3, 2025
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 3, 2025

Quality Gate Failed Quality Gate failed

Failed conditions
1 Security Hotspot

See analysis details on SonarQube Cloud

@riverma
Copy link
Collaborator Author

riverma commented Jun 3, 2025

FYI @anilnatha - this is a WIP but let me know what you think about the script!

@riverma riverma added the medium complexity Ticket is relatively straightforward but may have a difficult sub-task label Jun 5, 2025
python gh-security-settings.py -o OWNER -r REPO -t TOKEN

# Enable all security features
python gh-security-settings.py -o OWNER -r REPO -t TOKEN -a enable
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm assuming that this is shorthand for providing the -f all option? @riverma

Copy link
Contributor

@anilnatha anilnatha left a comment

Choose a reason for hiding this comment

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

LGTM!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

medium complexity Ticket is relatively straightforward but may have a difficult sub-task most requested Highly requested by community members software lifecycle Process improvements involving developing, testing, integrating, deploying software website Improvement / fix to the SLIM website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants