-
Notifications
You must be signed in to change notification settings - Fork 166
chore: New GitHub Actions workflows to automate code quality checks, testing, and repository maintenance #702
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Cleaned up whitespace and formatting in blob_service.py, cosmos_service.py, search_service.py, and settings.py. - Ensured consistent spacing and indentation throughout the codebase. - Enhanced code clarity by removing unnecessary blank lines and aligning comments. - No functional changes were made; this commit focuses solely on code style improvements.
…emetry template validation, and backend testing
…cripts for quota verification
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds CI automation (tests/coverage, linting, CodeQL, link checking, telemetry validation, stale maintenance) plus documentation and a quota-check helper script, alongside minor backend formatting/cleanup changes.
Changes:
- Added multiple GitHub Actions workflows for testing, linting, CodeQL, markdown link checks, telemetry template validation, and stale/branch reporting.
- Added Azure OpenAI quota-check documentation + a helper script (with supporting images).
- Performed minor backend cleanup (formatting, constant placement, explicit exception catches).
Reviewed changes
Copilot reviewed 14 out of 22 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| content-gen/src/backend/settings.py | Whitespace/formatting tweaks and minor doc formatting. |
| content-gen/src/backend/services/search_service.py | Formatting-only adjustments in service implementation. |
| content-gen/src/backend/services/cosmos_service.py | Formatting-only adjustments in Cosmos service. |
| content-gen/src/backend/services/blob_service.py | Formatting-only adjustments in Blob service. |
| content-gen/src/backend/orchestrator.py | Moves TOKEN_ENDPOINT and replaces bare except with except Exception; formatting cleanup. |
| content-gen/src/backend/models.py | Formatting-only adjustments in model definitions. |
| content-gen/src/backend/app.py | Formatting cleanup; removes unnecessary global statements; minor readability edits. |
| content-gen/src/backend/api/admin.py | Formatting-only adjustments in admin API endpoints. |
| content-gen/src/backend/agents/image_content_agent.py | Formatting cleanup; minor prompt text formatting. |
| content-gen/infra/script/quota_check_params.sh | Adds a quota-check script to evaluate Azure OpenAI quota availability by region/model. |
| content-gen/docs/images/quota-check-output.png | Adds documentation image for quota-check sample output. |
| content-gen/docs/images/git_bash.png | Adds documentation image showing Git Bash selection. |
| content-gen/docs/QuotaCheck.md | Adds quota-check documentation and usage instructions. |
| content-gen/docs/AzureAccountSetUp.md | Adds Azure account setup documentation for prerequisites/permissions. |
| README.md | Updates root README links to point to the new docs location under content-gen/docs. |
| .github/workflows/test.yml | Adds backend pytest workflow with coverage (currently misconfigured paths). |
| .github/workflows/telemetry-template-check.yml | Adds workflow to validate template: presence in content-gen/azure.yaml. |
| .github/workflows/stale-bot.yml | Adds stale issue/PR automation and an inactive-branches CSV report job. |
| .github/workflows/pylint.yml | Adds a lint workflow (currently runs flake8 only despite naming). |
| .github/workflows/codeql.yml | Adds CodeQL scanning for Python. |
| .github/workflows/broken-links-checker.yml | Adds lychee-based markdown link checking on PRs/manual runs. |
| .flake8 | Adds a flake8 configuration file to standardize lint settings. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… parsing failures
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 14 out of 22 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…orchestrator.py; add model availability check in quota_check_params.sh
…ve unused fallback logic
…te and pagination for better accuracy
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 14 out of 22 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… and update documentation for login command
Purpose
This pull request introduces several new GitHub Actions workflows to automate code quality checks, testing, and repository maintenance, as well as some minor code cleanups and configuration updates. The main focus is on improving CI/CD coverage, enforcing code standards, and automating repository hygiene.
CI/CD and Automation Enhancements:
mainanddevbranches. This workflow installs dependencies, checks for test files, and runs tests with coverage if present.flake8linting on backend Python files when relevant files are changed or on push.lychee-action.templateproperty incontent-gen/azure.yamlfor telemetry purposes.Configuration and Code Quality:
.flake8configuration file to standardize linting rules, including line length, ignored warnings, and excluded directories.Minor Code Cleanups:
TOKEN_ENDPOINTinorchestrator.pyfor clarity, and made exception handling more explicit by catchingExceptioninstead of a bareexcept. [1] [2] [3] [4]globalstatements and reformatting endpoint assignment for clarity. [1] [2] [3]These changes collectively improve code quality, automate critical checks, and help keep the repository organized and healthy.
Does this introduce a breaking change?
What to Check
Verify the GitHub Actions workflows