Skip to content

Commit 4bec54f

Browse files
committed
Enhance project documentation and configuration files
- Updated CONTRIBUTING.md to improve clarity and structure. - Cleaned up dependabot.yml by removing unnecessary whitespace. - Modified release-drafter.yml for consistent quotation style and formatting. - Adjusted workflows (black.yml, codeql.yml, deploy-PROD.yml, deploy-RELEASE.yml, docker-publish.yml) for consistent quotation marks and formatting. - Refined .pre-commit-config.yaml by removing redundant entries and ensuring proper formatting. - Improved launch.json formatting in .vscode for better readability. - Enhanced README.md with clearer formatting and additional spacing for improved readability. - Refactored app.py and various GitHub app modules (azuread.py, core.py, googleworkspace.py, keycloak.py, ldap.py, okta.py, onelogin.py) for consistent import ordering and formatting.
1 parent 6f7b97c commit 4bec54f

20 files changed

+801
-767
lines changed

.automation/upload-docker.sh

Lines changed: 375 additions & 375 deletions
Large diffs are not rendered by default.

.github/CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# Contributing
2+
23
:wave: Hi there!
34
We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
45

56
## Submitting a pull request
7+
68
[Pull Requests][pulls] are used for adding new functionality, fixing bugs, improving documentation, and improving the developer experience overall.
79

810
**With write access**
11+
912
1. Clone the repository (only if you do not have write access)
1013
1. Run `pipenv install`
1114
1. Create a new branch: `git checkout -b <username>/<my-branch-name>`
@@ -16,6 +19,7 @@ We're thrilled that you'd like to contribute to this project. Your help is essen
1619
1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
1720

1821
**Without write access**
22+
1923
1. [Fork][fork] and clone the repository
2024
1. Run `pipenv install`
2125
1. Create a new branch: `git checkout -b <username>/<my-branch-name>`
@@ -38,6 +42,7 @@ Work in Progress pull requests are also welcome to get feedback early on, or if
3842
- Open a pull request and request a review from a member of the appropriate `@github/ps-delivery` and/or `@github/ps-devops-engineering` teams
3943

4044
## Resources
45+
4146
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
4247
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
4348
- [GitHub Help](https://help.github.com)

.github/dependabot.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ updates:
1616
interval: "daily"
1717
open-pull-requests-limit: 10
1818

19-
2019
# Maintain dependencies for docker
2120
- package-ecosystem: "docker"
2221
directory: "/"

.github/release-drafter.yml

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
1-
name-template: 'v$RESOLVED_VERSION'
2-
tag-template: 'v$RESOLVED_VERSION'
1+
name-template: "v$RESOLVED_VERSION"
2+
tag-template: "v$RESOLVED_VERSION"
33
template: |
44
# Changelog
55
$CHANGES
6-
7-
See details of [all code changes](https://github.com/github/github-team-sync/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release
8-
6+
7+
See details of [all code changes](https://github.com/github/github-team-sync/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release
8+
99
categories:
10-
- title: '🚀 Features'
10+
- title: "🚀 Features"
1111
labels:
12-
- 'feature'
13-
- 'enhancement'
14-
- title: '🐛 Bug Fixes'
12+
- "feature"
13+
- "enhancement"
14+
- title: "🐛 Bug Fixes"
1515
labels:
16-
- 'fix'
17-
- 'bugfix'
18-
- 'bug'
19-
- title: '🧰 Maintenance'
16+
- "fix"
17+
- "bugfix"
18+
- "bug"
19+
- title: "🧰 Maintenance"
2020
labels:
21-
- 'infrastructure'
22-
- 'automation'
23-
- 'documentation'
24-
- 'dependencies'
25-
- title: '🏎 Performance'
26-
label: 'performance'
27-
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
21+
- "infrastructure"
22+
- "automation"
23+
- "documentation"
24+
- "dependencies"
25+
- title: "🏎 Performance"
26+
label: "performance"
27+
change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
2828
version-resolver:
2929
major:
3030
labels:
31-
- 'type: breaking'
31+
- "type: breaking"
3232
minor:
3333
labels:
34-
- 'type: enhancement'
34+
- "type: enhancement"
3535
patch:
3636
labels:
37-
- 'type: bug'
38-
- 'type: maintenance'
39-
- 'type: documentation'
37+
- "type: bug"
38+
- "type: maintenance"
39+
- "type: documentation"
4040
default: patch

.github/workflows/black.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,27 @@ name: Code Formatting
22

33
on:
44
push:
5-
branches-ignore:
5+
branches-ignore:
66
- main
77
pull_request:
8-
types:
8+
types:
99
- opened
1010
- ready_for_review
1111
- reopened
1212

1313
jobs:
1414
ci:
15-
runs-on: 'ubuntu-latest'
15+
runs-on: "ubuntu-latest"
1616
name: PR Formatter
1717

1818
steps:
1919
- name: Checkout repo
2020
uses: actions/checkout@v3
21-
21+
2222
- name: Install python
2323
uses: actions/setup-python@v3
2424
with:
25-
python-version: '3.9'
25+
python-version: "3.9"
2626

2727
- name: Format the code
2828
uses: psf/black@stable

.github/workflows/codeql.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
push:
66
branches: [main]
77
schedule:
8-
- cron: '30 1 * * 0' # Weekly scan
8+
- cron: "30 1 * * 0" # Weekly scan
99

1010
jobs:
1111
codeql-analyze:
@@ -18,8 +18,8 @@ jobs:
1818
strategy:
1919
fail-fast: false
2020
matrix:
21-
language: ['python']
22-
build-mode: ['none'] # Use manual here if needed
21+
language: ["python"]
22+
build-mode: ["none"] # Use manual here if needed
2323

2424
steps:
2525
- name: Checkout repository

.github/workflows/deploy-PROD.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
on:
1717
push:
1818
branches:
19-
- 'master'
19+
- "master"
2020

2121
###############
2222
# Set the Job #

.github/workflows/deploy-RELEASE.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
on:
1717
release:
1818
# Want to run the automation when a release is created
19-
types: ['published']
19+
types: ["published"]
2020

2121
###############
2222
# Set the Job #

.github/workflows/docker-publish.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ env:
1616

1717
jobs:
1818
push:
19-
2019
runs-on: ubuntu-latest
2120
if: github.event_name == 'push'
2221

.pre-commit-config.yaml

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
repos:
2+
- repo: https://github.com/psf/black
3+
rev: 20.8b1
4+
hooks:
5+
- id: black
26

3-
- repo: https://github.com/psf/black
4-
rev: 20.8b1
5-
hooks:
6-
- id: black
7+
- repo: https://github.com/pre-commit/mirrors-isort
8+
rev: v5.7.0
9+
hooks:
10+
- id: isort
11+
args: ["--profile", "black", "--filter-files"]
712

8-
- repo: https://github.com/pre-commit/mirrors-isort
9-
rev: v5.7.0
10-
hooks:
11-
- id: isort
12-
args: ["--profile", "black", "--filter-files"]
13-
14-
- repo: https://github.com/pre-commit/pre-commit-hooks
15-
rev: v3.4.0
16-
hooks:
17-
- id: check-added-large-files
18-
args: ['--maxkb=1500']
13+
- repo: https://github.com/pre-commit/pre-commit-hooks
14+
rev: v3.4.0
15+
hooks:
16+
- id: check-added-large-files
17+
args: ["--maxkb=1500"]

0 commit comments

Comments
 (0)