Skip to content

Audit & optimize repo settings for public launch#7

Merged
dhilgaertner merged 2 commits intomainfrom
feature/citadel-helm-5-audit-repo-settings
Mar 9, 2026
Merged

Audit & optimize repo settings for public launch#7
dhilgaertner merged 2 commits intomainfrom
feature/citadel-helm-5-audit-repo-settings

Conversation

@dhilgaertner
Copy link
Contributor

@dhilgaertner dhilgaertner commented Mar 9, 2026

Summary

  • Switch license from Apache 2.0 to MIT (Copyright 2025 Radius Method)
  • Add CODEOWNERS (* @radiusmethod/engineering)
  • Add GitHub issue templates (bug report, feature request) and PR template
  • Add kubelinter step to CI lint workflow
  • Add Renovate config for automated dependency updates
  • Remove Code of Conduct section from CONTRIBUTING.md

Closes #5

Test plan

  • helm lint . --set citadel.secretKey=test passes
  • helm template citadel . --set citadel.secretKey=test renders correctly
  • CI lint workflow passes (including new kubelinter step)
  • Issue templates render correctly on GitHub
  • CODEOWNERS is recognized by GitHub

🤖 Generated with Claude Code

dhilgaertner and others added 2 commits March 9, 2026 16:13
Switch license from Apache 2.0 to MIT, add community health files
(CODEOWNERS, issue/PR templates), configure Renovate for dependency
updates, and add kubelinter to CI pipeline.

Closes #5

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Lint only our own templates (not postgresql subchart) and exclude checks
for resource limits, read-only root fs, and latest tags that don't apply
to init containers and test pods in CI.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Collaborator

@dgershman dgershman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code & Security Review

Critical Issues

None.

Security Review

Strengths:

  • License change from Apache 2.0 to MIT is clean and valid (Copyright 2025 Radius Method)
  • Issue templates remind users to redact secrets in bug reports (.github/ISSUE_TEMPLATE/bug_report.yml:29)
  • kubelinter addition catches Kubernetes security misconfigurations in CI
  • CODEOWNERS ensures PRs get reviewed by @radiusmethod/engineering

Concerns:

  • kubelinter install uses /releases/latest (.github/workflows/lint.yaml:31) — this downloads whatever the latest version is at runtime, which means builds aren't reproducible and a compromised release could affect CI. Consider pinning to a specific version (e.g. v0.7.2) or using the official stackrox/kube-linter-action GitHub Action with a pinned version.
  • kube-linter exclusions are broad (.kube-linter.yaml:4-8) — excluding run-as-non-root, no-read-only-root-fs, and latest-tag globally rather than per-resource means these checks won't fire for any resource, including the main deployment container. The comment says "init containers and test pods" but the exclusions apply chart-wide. Consider scoping exclusions to specific objects if possible, or at least updating the comment to reflect the actual scope.
  • kubelinter binary downloaded over HTTPS without checksum verification (.github/workflows/lint.yaml:31) — no integrity check on the downloaded binary. Lower risk since it's from GitHub releases, but worth noting.

Code Quality

  • Issue templates are well-structured with appropriate required fields
  • PR template includes useful checklist (chart version bump, docs update, changelog)
  • Renovate config is minimal and uses recommended defaults — good
  • Removing the Code of Conduct section from CONTRIBUTING.md is fine (it was just a one-liner)
  • README.md license reference updated to match — consistent

Summary Table

Priority Issue
🟡 Yellow kubelinter installed from /latest — pin version for reproducible builds
🟡 Yellow kube-linter exclusions are chart-wide, not scoped to init containers as comment suggests
🟢 Green No checksum verification on kubelinter binary download

Recommendation: Approve — This is a solid repo hygiene PR. The kubelinter version pinning is worth addressing in a follow-up but isn't blocking. All changes are well-organized and appropriate for a public launch.

@dhilgaertner dhilgaertner merged commit b56dc34 into main Mar 9, 2026
1 check passed
@dhilgaertner dhilgaertner deleted the feature/citadel-helm-5-audit-repo-settings branch March 9, 2026 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Audit and optimize GitHub repo settings for public open-source launch

2 participants