chore(docs): Add some more convenience and update local setup#879
Conversation
Signed-off-by: Jonas Brand (8R0WNI3) <jonasbrand1712@gmail.com>
8R0WNI3
added
kind/chore
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughRenames component identifiers across feature, extension, bootstrapping, and profile YAML configs. Adds a ChangesComponent rename across config
Local development tooling
Estimated code review effort: 2 (Simple) | ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
️✅ There are no secrets present in this pull request anymore.If these secrets were true positive and are still valid, we highly recommend you to revoke them. 🦉 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. |
![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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@Makefile`:
- Around line 98-107: The run-db target is missing the POSTGRES_DB setting, so
it can create a database name that drifts from the run target’s DB_NAME. Update
the run-db recipe to pass POSTGRES_DB using DB_NAME alongside the existing
POSTGRES_USER and POSTGRES_PASSWORD in the docker run command. Also address the
container name conflict in the run-db target by making repeated runs safe with
either --rm or a different lifecycle strategy, and keep the recipe formatting
consistent with the surrounding Makefile target.
In `@src/secrets/signing-cfg/local.yaml`:
- Around line 5-56: The local signing config currently embeds a real RSA private
key, which triggers secret scanning and blocks CI. Update the signing-cfg setup
around the local YAML and the jwt_from_signing_cfg-compatible key fields so no
committed private key remains in the repo: either replace the embedded key with
a generated-at-setup value or add a narrowly scoped secret-scanner
allowlist/ignore for this file with clear local-only justification. Keep the
existing algorithm/id/private_key/public_key shape intact so the loader still
works.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 66cdf06b-92b8-4b9d-8be8-97240d072fc1
📒 Files selected for processing (7)
Makefilecharts/bootstrapping/values.example.yamlcharts/bootstrapping/values.minimal.yamlsrc/features/features_cfg.yamlsrc/odg/extensions_cfg.yamlsrc/odg/profiles.yamlsrc/secrets/signing-cfg/local.yaml
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@Makefile`:
- Line 105: The docker run argument for POSTGRES_DB is missing its closing
quote, which causes the shell to merge it with the next option and break the
command. Fix the Makefile’s docker invocation by closing the quoted POSTGRES_DB
value in the same place it is opened, keeping the subsequent port mapping and
other flags separate; use the docker run block around POSTGRES_DB and the
related -p option to verify the quoting is balanced.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1a7cea49-53fc-4460-827a-28fe1e18a85a
📒 Files selected for processing (2)
Makefilesrc/secrets/signing-cfg/local.yaml
Signed-off-by: Jonas Brand (8R0WNI3) <jonasbrand1712@gmail.com>
8R0WNI3
force-pushed
the
local-setup
branch
2 times, most recently
from
169d77c to
a77b60c
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.gitguardian.yaml:
- Around line 1-5: The GitGuardian ignore entry is masking a committed private
key instead of removing it. Update the handling around .gitguardian.yaml and
src/secrets/signing-cfg/local.yaml so no real PEM key material is committed;
replace it with a placeholder or a setup-time generator script (as suggested by
the signing-cfg flow and values.documentation.yaml), and remove the ignore rule.
If this key was already pushed, regenerate and rotate it.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f4bf4e24-5717-491b-912d-a1ccaeeb74a0
📒 Files selected for processing (3)
.gitguardian.yamlMakefilesrc/secrets/signing-cfg/local.yaml
There was a problem hiding this comment.
🧹 Nitpick comments (1)
Makefile (1)
49-49: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value
uuidgenmay not be present on all dev machines.
uuidgenisn't universally installed (e.g. some minimal Linux setups lackutil-linux/uuid-runtime). Consider a more portable fallback such aspython3 -c 'import uuid; print(uuid.uuid4())', which is already a dependency here given the pip step above.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@Makefile` at line 49, The Makefile target currently relies on uuidgen, which may not exist on all developer machines. Update the command that prints the id so it uses a portable UUID generator fallback, such as the existing Python 3 dependency, and keep the output format the same. Locate the change in the shell snippet that emits the id value and replace the uuidgen call with a more widely available approach.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@Makefile`:
- Line 49: The Makefile target currently relies on uuidgen, which may not exist
on all developer machines. Update the command that prints the id so it uses a
portable UUID generator fallback, such as the existing Python 3 dependency, and
keep the output format the same. Locate the change in the shell snippet that
emits the id value and replace the uuidgen call with a more widely available
approach.
Signed-off-by: Jonas Brand (8R0WNI3) <jonasbrand1712@gmail.com>
2 participants
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Release note: