Advanced-Security-Enforcer
What this repository does
This code is for an active GitHub Action written in Python to check (on a schedule) for new repositories created in the last 24 hours and open pull requests in the new repositories to enable GitHub advanced security code scanning.
Support
If you need support using this project or have questions about it, please open up an issue in this repository. Requests made directly to GitHub staff or support team will be redirected here to open an issue. GitHub SLA's and support/services contracts do not apply to this repository.
Example workflow
name: Enforce advanced security scanning
on:
repository_dispatch:
schedule:
- cron: '00 5 * * *'
jobs:
build:
name: Enforce advanced security scanning
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Run enforcer tool
uses: github/advanced-security-enforcer@v1
env:
GH_ACTOR: ${{ secrets.GH_ACTOR }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
ORGANIZATION: ${{ secrets.ORGANIZATION }}
PR_BODY: your text goes here
- Be sure to fill out the
envvalues above with your information. More info on creating secrets can be found here. - Your GitHub token will need to have read/write access to all the repos in the organization
How it does this
- A CRON job on GitHub actions triggers a nightly run of this script
- The script checks for new repositories by storing the known repositories to a file
- It then iterates over new repositories and opens a pull request for the codeql.yml file stored in this repository
Contributions
We would
Instructions to run locally
- Clone the repository
- Create a personal access token with read only permissions
- Copy the
.env-examplefile to.env - Edit the
.envfile by adding your Personal Access Token to it and the desired organization - Install dependencies
pip install -r requirements.txt - Run the code
python3 enforcer.py - Note the log output for details on any pull requests that were opened
- After running locally this will have changed your git config user.name and user.email so those should be reset for this repository
368 Jan 4, 2023
175 Dec 14, 2022
2 Mar 23, 2022
44 Nov 18, 2022
41 Dec 30, 2022
3 Feb 7, 2022
52 Dec 17, 2022
5 May 18, 2022
52 Jul 16, 2022
103 Aug 20, 2022
3.5k Jan 9, 2023
48 Oct 25, 2022
12 Dec 2, 2022
5 Mar 19, 2022
87 Dec 28, 2022
1 Nov 23, 2021
5 Dec 10, 2021
1 Dec 14, 2021
8 Feb 27, 2022