Docs and CI cleanup for VentusFlow - #6
Merged
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates project documentation and repository hygiene, and adds a basic CI pipeline to validate the Python backend syntax and the WebGUI frontend build.
Changes:
- Updated README setup instructions to reflect the consolidated
VentusFlowrepository and added a brief project structure overview. - Expanded
.gitignorepatterns to ignore common generated directories in nested paths. - Added a GitHub Actions workflow that compiles the Python backend file and builds the frontend on pushes/PRs.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Updates clone/start instructions and documents the repo layout. |
| .gitignore | Broadens ignore rules for common generated artifacts across subfolders. |
| .github/workflows/ci.yml | Adds CI to validate Python syntax, build the frontend, and detect generated files. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ``` | ||
| # Wenn Remote-Cluster-Funktionen genutzt werden sollen, aktualisiere ssh-agent Pfad im serve-Script-Eintrag der package.json Datei (lauffähiger Build wird mitgeliefert) | ||
| Nach dem Start ist die Anwendung unter `http://localhost:3000` (oder einem anderen Port, der in der Konsole angezeigt wird) erreichbar. |
Comment on lines
+30
to
+32
| - name: Install frontend dependencies | ||
| working-directory: VentusFlowWebGUI | ||
| run: npm install --no-fund --no-audit |
Comment on lines
+38
to
+43
| - name: Check for generated files in the working tree | ||
| run: | | ||
| if git ls-files --others --exclude-standard | grep -E '(^|/)(\.DS_Store|node_modules|dist|\.venv|__pycache__)(/|$)|(\.pyc|\.pyo)$' >/dev/null; then | ||
| echo 'Generated files detected in the repo. Remove them before committing.' | ||
| exit 1 | ||
| fi |
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Verification
added 137 packages in 6s
vite v6.2.3 building for production...
transforming...
✓ 214 modules transformed.
rendering chunks...
computing gzip size...
../dist/index.html 12.22 kB │ gzip: 3.61 kB
../dist/assets/index-BeGueYiS.css 12.95 kB │ gzip: 2.92 kB
../dist/assets/index-B1912KoB.js 367.82 kB │ gzip: 105.86 kB │ map: 2,184.65 kB
✓ built in 995ms