feat(dev): lightweight compose for quick iteration #1431
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
CI Feedback 🧐(Feedback updated until commit b9a4639)A test triggered by this PR failed. Here is an AI-generated analysis of the failure:
|
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||||
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed everything up to a56f63a in 1 minute and 21 seconds. Click for details.
- Reviewed
90lines of code in5files - Skipped
0files when reviewing. - Skipped posting
5draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. .github/workflows/generate-openapi-code-from-typespec.yml:34
- Draft comment:
Good use of 'git diff --exit-code' to enforce freshness. Consider adding 'set -eo pipefail' at the start of the run block to catch any errors immediately. - Reason this comment was not posted:
Comment was on unchanged code.
2. .pre-commit-config.yaml:6
- Draft comment:
Ensure that the generate_openapi_code.sh script is executable to avoid hook failures on some systems. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
3. CONTRIBUTING.md:163
- Draft comment:
Great addition of pre-commit installation instructions to ease onboarding for new contributors. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
4. deploy/docker-compose.dev.yaml:2
- Draft comment:
The use of the 'include' key and empty string profiles is non-standard; ensure your Docker Compose version or tooling supports this syntax. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the author to ensure compatibility with their Docker Compose version or tooling, which violates the rule against asking the author to ensure behavior is intended or tested. It doesn't provide a specific suggestion or ask for a specific change.
5. poe_tasks.toml:2
- Draft comment:
The dev-up task is clear; ensure the referenced .env file exists and has all required environment variables for successful startup. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
Workflow ID: wflow_hWpL3Vjzct37DMty
You can customize 
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 17693055 | Triggered | JSON Web Token | a601325 | cli/tests/test_auth.py | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
|
What is this for? are those services enough? what about production where we're not using memory-store service? |
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.
User description
Summary
Testing
pre-commit run --files openapi.yaml(fails: command not found)PR Type
Enhancement, Documentation
Description
Introduce lightweight Docker Compose file for dev iteration
Add
dev-uptask topoe_tasks.tomlfor simplified development workflowEnforce OpenAPI code generation freshness in CI and pre-commit
Update contributing guide to document pre-commit setup
Changes walkthrough 📝
docker-compose.dev.yaml
Add lightweight Docker Compose file for developmentdeploy/docker-compose.dev.yaml
poe_tasks.toml
Add dev-up task for simplified development startuppoe_tasks.toml
dev-uptask to run the new dev compose filegenerate-openapi-code-from-typespec.yml
Enforce OpenAPI codegen freshness in CI workflow.github/workflows/generate-openapi-code-from-typespec.yml
.pre-commit-config.yaml
Add pre-commit hook for OpenAPI codegen freshness.pre-commit-config.yaml
CONTRIBUTING.md
Document pre-commit setup in contributing guideCONTRIBUTING.md