setup CICD workflow #3
Merged
Conversation
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
|
Caution Review failedThe pull request is closed. WalkthroughThis change adds a new Changes
Sequence Diagram(s)sequenceDiagram
participant GitHub
participant Workflow (Prettier)
participant PR Author
GitHub->>Workflow (Prettier): Trigger on push or PR event
Workflow (Prettier)->>Workflow (Prettier): Checkout code, setup Node.js, run Prettier check
alt Formatting issues detected & event is PR
Workflow (Prettier)->>PR Author: Post comment with list of files and formatting instructions
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (3)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
.coderabbit.yaml (1)
14-16: Minor grammar tweak for clarityCurrent: “dashboards are portable and does not check in specific host names”
Suggested: “dashboards are portable and do not check in specific host names”.- dashboards are portable and does not check in specific host names, or refer to + dashboards are portable and do not check in specific host names, or refer to.github/workflows/prettier.yml (2)
29-38: Avoid running Prettier twiceThe “Get files that need formatting” step executes the same expensive check again.
Capture the list on the first execution to reuse later, or use Prettier’s--loglevel silent+$?to propagate the list without re-invoking the binary.
40-69: Multi-line template loses indentation inside PR commentThe back-ticked JS template literal keeps the YAML indentation, so lines 48-62 will render with extra leading spaces in GitHub comments.
Wrap the string withdedentor align it flush-left to improve readability.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro (Legacy)
📒 Files selected for processing (2)
.coderabbit.yaml(1 hunks).github/workflows/prettier.yml(1 hunks)
🧰 Additional context used
🧠 Learnings (10)
📓 Common learnings
Learnt from: daniel-falk
PR: fixedit-ai/FixedIT-Developer-Friend#17
File: cloud_infra/README.md:1-35
Timestamp: 2025-07-01T11:34:26.699Z
Learning: User daniel-falk prefers using `prettier -w *.md` for markdown formatting instead of manual markdown fixes, and plans to integrate automated formatting into CI/CD pipelines systematically.
Learnt from: daniel-falk
PR: fixedit-ai/FixedIT-Developer-Friend#17
File: cloud_infra/lambdas/fixedit-developer-friend-devcloud-dependency-cache/index.py:61-62
Timestamp: 2025-07-01T11:33:53.832Z
Learning: User daniel-falk prefers using automated formatting tools like `black` for Python code formatting instead of manual PEP 8 fixes, and plans to integrate these tools into CI/CD pipelines. They also recommend `autopep8` for finding additional issues like incorrect names.
Learnt from: daniel-falk
PR: fixedit-ai/Axis-ACAP-libraries#54
File: libraries/builder-base/Makefile:1-5
Timestamp: 2024-10-25T10:25:19.311Z
Learning: - When suggesting code changes, include steps to pin the versions of tools like `mypy` and `black` for consistency.
- Include formatting and linting of YAML files in the workflows directory when setting up static tests.
Learnt from: daniel-falk
PR: fixedit-ai/client-doordash#19
File: .github/workflows/unit_tests.yml:3-7
Timestamp: 2024-11-05T09:37:26.633Z
Learning: In the `.github/workflows/unit_tests.yml` workflow, it's acceptable to use only the `push` trigger if running tests on all pushes covers the necessary cases. Including the `pull_request` trigger may be unnecessary unless handling contributions from forked repositories or pull requests without new commits.
Learnt from: daniel-falk
PR: fixedit-ai/FixedIT-Developer-Friend#17
File: cloud_infra/cloud_formation/web-service.yaml:67-67
Timestamp: 2025-07-28T10:11:12.253Z
Learning: User daniel-falk prefers managing sensitive configuration like API tokens through environment variables that are validated at deployment time, with clear error messages when required variables are missing. For CI/CD scenarios, these should be configured as repository secrets rather than hardcoded values.
Learnt from: fixedit-olatz
PR: fixedit-ai/fixedit-agents#295
File: acaps/config_agent/app/src/vapix_stream_profiles.cpp:126-134
Timestamp: 2025-06-18T09:44:13.318Z
Learning: When creating GitHub issues for refactoring tasks in the FixedIT codebase, include comprehensive file lists, clear before/after code examples, implementation notes, and proper backlinks to the original discussion for better tracking and context.
Learnt from: daniel-falk
PR: fixedit-ai/client-doordash#40
File: acaps/bootstrap_agent/fixedit-manifest-host.json:7-7
Timestamp: 2024-11-11T17:24:24.438Z
Learning: In PR #37 (https://github.com/fixedit-ai/client-doordash/pull/37), the build for host was fixed.
Learnt from: fixedit-olatz
PR: fixedit-ai/client-doordash#6
File: bootstrap_agent/app/src/installer_logic/acap_manager.cpp:76-109
Timestamp: 2024-10-30T13:55:27.450Z
Learning: When error handling improvements are suggested in code reviews, the team may choose to implement them in a separate PR.
Learnt from: daniel-falk
PR: fixedit-ai/fixedit-agents#359
File: TEST_INSTRUCTIONS.md:244-245
Timestamp: 2025-07-03T15:28:04.994Z
Learning: In the fixedit-ai/fixedit-agents project, the configs_for_build directory is only used for plugin parsing purposes. Files in this directory should not be updated unless necessary because it breaks the build cache unnecessarily. Build cache optimization is an important consideration when making changes to configuration files.
Learnt from: daniel-falk
PR: fixedit-ai/FixedIT-Developer-Friend#4
File: vscode_plugins/acap-documentation-viewer/src/utils/utils.ts:1-1
Timestamp: 2025-06-16T15:00:52.939Z
Learning: User daniel-falk prefers using established, well-tested JavaScript libraries over custom implementations for standard functionality like string sanitization, URL validation, and template inflation, especially for security-critical operations.
Learnt from: daniel-falk
PR: fixedit-ai/FixedIT-Developer-Friend#17
File: cloud_infra/lambdas/fixedit-developer-friend-devcloud-dependency-cache/index.py:67-67
Timestamp: 2025-07-27T10:49:53.485Z
Learning: User daniel-falk prefers explicit type annotations with proper dependencies over fallback mechanisms that silently disable type checking. He believes that if proper type hints are used, the required libraries should be added as dependencies rather than falling back to Any, which defeats the purpose of type checking.
Learnt from: daniel-falk
PR: fixedit-ai/FixedIT-Developer-Friend#17
File: cloud_infra/README.md:0-0
Timestamp: 2025-07-27T10:43:21.696Z
Learning: User daniel-falk prefers conservative documentation that only claims compatibility with Python versions that are actually tested, rather than making broad compatibility claims like "Python 3.8+" without verification. He believes it's better to document the specific version being used and tested rather than potentially fragile compatibility statements.
Learnt from: daniel-falk
PR: fixedit-ai/FixedIT-Developer-Friend#4
File: vscode_plugins/acap-documentation-viewer/src/controller/ResultWebview.ts:0-0
Timestamp: 2025-07-11T10:09:50.781Z
Learning: User daniel-falk prefers detailed, verbose comments that explain the "why" behind code decisions, not just the "what". Comments should provide extra context and be written for readers' understanding, even if they're longer. This applies especially to security-related code where explaining the reasoning (like CSP nonce generation for XSS prevention) adds valuable context.
📚 Learning: - when suggesting code changes, include steps to pin the versions of tools like `mypy` and `black` f...
Learnt from: daniel-falk
PR: fixedit-ai/Axis-ACAP-libraries#54
File: libraries/builder-base/Makefile:1-5
Timestamp: 2024-10-25T10:25:19.311Z
Learning: - When suggesting code changes, include steps to pin the versions of tools like `mypy` and `black` for consistency.
- Include formatting and linting of YAML files in the workflows directory when setting up static tests.
Applied to files:
.coderabbit.yaml.github/workflows/prettier.yml
📚 Learning: in the fixedit-ai/client-doordash repository, detailed documentation should be maintained in per-app...
Learnt from: daniel-falk
PR: fixedit-ai/client-doordash#268
File: acaps/telegraf_agent/frontend/README.md:2-3
Timestamp: 2025-05-15T13:40:02.484Z
Learning: In the fixedit-ai/client-doordash repository, detailed documentation should be maintained in per-application README files rather than in the main README.md file.
Applied to files:
.coderabbit.yaml
📚 Learning: in the fixedit-ai/fixedit-agents project, when creating documentation that will be converted to pdf ...
Learnt from: daniel-falk
PR: fixedit-ai/fixedit-agents#428
File: acaps/fixedit_data_agent/QUICKSTART_GUIDE.md:41-45
Timestamp: 2025-07-23T14:25:38.892Z
Learning: In the fixedit-ai/fixedit-agents project, when creating documentation that will be converted to PDF (like QUICKSTART_GUIDE.md), PDF output quality and formatting takes priority over GitHub markdown rendering. LaTeX environments like \begin{scriptsize} and \begin{verbatim} should be preserved even if they break GitHub preview, because end users primarily read the PDF versions rather than the GitHub markdown. This prioritizes user experience over developer experience.
Applied to files:
.coderabbit.yaml
📚 Learning: in the vscode_plugins/acap-documentation-viewer project, public documentation (readme, changelog) is...
Learnt from: daniel-falk
PR: fixedit-ai/FixedIT-Developer-Friend#14
File: vscode_plugins/acap-documentation-viewer/DEVELOP.md:85-85
Timestamp: 2025-08-01T08:43:55.730Z
Learning: In the vscode_plugins/acap-documentation-viewer project, public documentation (README, CHANGELOG) is intended for end users of the VS Code extension and should not include internal implementation details like data type conversion flows or system architecture. Developer documentation (DEVELOP.md) is the appropriate place for internal technical details that developers working on the extension need to understand.
Applied to files:
.coderabbit.yaml
📚 Learning: in prototypes/dashboards/dashboard-json-files/, the grafana dashboard json files are automatically g...
Learnt from: daniel-falk
PR: fixedit-ai/fixedit-agents#385
File: prototypes/dashboards/dashboard-json-files/config_agent.json:607-644
Timestamp: 2025-07-04T12:18:25.332Z
Learning: In prototypes/dashboards/dashboard-json-files/, the Grafana dashboard JSON files are automatically generated by Grafana. Manual optimizations or code style suggestions should not be applied to these files since changes would be overwritten when dashboards are updated through the Grafana UI.
Applied to files:
.coderabbit.yaml
📚 Learning: when creating github issues for refactoring tasks in the fixedit codebase, include comprehensive fil...
Learnt from: fixedit-olatz
PR: fixedit-ai/fixedit-agents#295
File: acaps/config_agent/app/src/vapix_stream_profiles.cpp:126-134
Timestamp: 2025-06-18T09:44:13.318Z
Learning: When creating GitHub issues for refactoring tasks in the FixedIT codebase, include comprehensive file lists, clear before/after code examples, implementation notes, and proper backlinks to the original discussion for better tracking and context.
Applied to files:
.coderabbit.yaml
📚 Learning: user daniel-falk prefers using `prettier -w *.md` for markdown formatting instead of manual markdown...
Learnt from: daniel-falk
PR: fixedit-ai/FixedIT-Developer-Friend#17
File: cloud_infra/README.md:1-35
Timestamp: 2025-07-01T11:34:26.699Z
Learning: User daniel-falk prefers using `prettier -w *.md` for markdown formatting instead of manual markdown fixes, and plans to integrate automated formatting into CI/CD pipelines systematically.
Applied to files:
.github/workflows/prettier.yml
📚 Learning: in the `.github/workflows/unit_tests.yml` workflow, it's acceptable to use only the `push` trigger i...
Learnt from: daniel-falk
PR: fixedit-ai/client-doordash#19
File: .github/workflows/unit_tests.yml:3-7
Timestamp: 2024-11-05T09:37:26.633Z
Learning: In the `.github/workflows/unit_tests.yml` workflow, it's acceptable to use only the `push` trigger if running tests on all pushes covers the necessary cases. Including the `pull_request` trigger may be unnecessary unless handling contributions from forked repositories or pull requests without new commits.
Applied to files:
.github/workflows/prettier.yml
📚 Learning: in the github actions workflows for this repository, the fixedit cli will produce an error if multip...
Learnt from: daniel-falk
PR: fixedit-ai/client-doordash#37
File: .github/workflows/build_and_test_acaps.yml:133-149
Timestamp: 2024-11-12T11:57:32.569Z
Learning: In the GitHub Actions workflows for this repository, the FixedIT CLI will produce an error if multiple files are produced, so it is safe to assume only one file will be generated.
Applied to files:
.github/workflows/prettier.yml
🪛 YAMLlint (1.37.1)
.coderabbit.yaml
[error] 9-9: trailing spaces
(trailing-spaces)
[error] 10-10: trailing spaces
(trailing-spaces)
[error] 11-11: trailing spaces
(trailing-spaces)
[error] 12-12: trailing spaces
(trailing-spaces)
[error] 13-13: trailing spaces
(trailing-spaces)
[error] 19-19: trailing spaces
(trailing-spaces)
[error] 20-20: trailing spaces
(trailing-spaces)
[error] 21-21: trailing spaces
(trailing-spaces)
[error] 28-28: trailing spaces
(trailing-spaces)
[error] 29-29: trailing spaces
(trailing-spaces)
[error] 30-30: trailing spaces
(trailing-spaces)
[error] 31-31: trailing spaces
(trailing-spaces)
[error] 32-32: trailing spaces
(trailing-spaces)
🔇 Additional comments (1)
.coderabbit.yaml (1)
33-34: Ensure Prettier is actually enforced on this fileYou mention “We use Prettier for formatting … yaml, json, etc.”.
Since the workflow only checks formatting, any push that includes this file with trailing whitespace (see above) will fail. Consider adding a pre-commit hook (e.g.,prettier --write) or runningprettier --checkin a separate job that also auto-formats and commits back for convenience.
daniel-falk
force-pushed
the
feature/setup-prettier-workflow
branch
from
c9a5bbe to
eadefcd
Compare
fixedit-olatz
approved these changes
Aug 5, 2025
daniel-falk
force-pushed
the
feature/setup-prettier-workflow
branch
from
eadefcd to
34f706a
Compare
daniel-falk
changed the base branch from
feature/add-monitoring-dashboard
to
main
Sign up for free
to 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.
This PR adds a CICD job to test the formatting of common files like JSON, YML, md, etc. It also adds review instructions for @coderabbitai.
Summary by CodeRabbit