Repository navigation
feat: enhance documentation and CI/CD processes - #13
Merged
Merged
Conversation
- Updated `.gitignore` to include `docs/openapi.json` for tracking the OpenAPI schema. - Enhanced `CONTRIBUTING.md` with clearer instructions on dependency management and added a note about running `uv lock` for reproducible installs. - Modified `Makefile` to include linting in the validation process for both backend and frontend. - Added `uv.lock` for reproducible Python dependency management. - Introduced CodeQL and Dependabot configurations for automated security analysis and dependency updates. - Updated CI workflows to utilize `uv` for dependency management and improved linting and testing steps. - Created `openapi.json` and a script to export the OpenAPI schema for offline use. - Enhanced various documentation files for clarity and completeness, including API reference and deployment instructions.
- Enhanced ESLint configuration by adding specific rules for CommonJS and React hooks. - Updated the lint command in package.json to use ESLint directly instead of Next.js linting. - Removed unnecessary validation logic in the AdvancedConfigContent component. - Simplified the createScenarioFromRun function call in the RunDetailPage component.
…r management - Set `prune-cache` to false in CI and release workflows to retain cached dependencies. - Added a step to stop servers after E2E tests to ensure a clean environment for subsequent runs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
.gitignoreto includedocs/openapi.jsonfor tracking the OpenAPI schema.CONTRIBUTING.mdwith clearer instructions on dependency management and added a note about runninguv lockfor reproducible installs.Makefileto include linting in the validation process for both backend and frontend.uv.lockfor reproducible Python dependency management.uvfor dependency management and improved linting and testing steps.openapi.jsonand a script to export the OpenAPI schema for offline use.Description
Brief description of the change.
Affected area
Validation completed
uv run pytest -q(ormake backend-test)cd frontend && npm test(ormake frontend-test)cd frontend && npx tsc --noEmit(ormake frontend-typecheck)cd frontend && npm run build(ormake frontend-build)(Or confirm
make validate-allpassed.)Screenshots / artifacts
If UI or behavior changed, add screenshots or example outputs where helpful.
Related issues
Fixes # (issue number if applicable).