Skip to content

feat: rename binary to pgedge-control-plane#294

Merged
jason-lynch merged 1 commit intomainfrom
feat/PLAT-417/rename-binary
Mar 31, 2026
Merged

feat: rename binary to pgedge-control-plane#294
jason-lynch merged 1 commit intomainfrom
feat/PLAT-417/rename-binary

Conversation

@jason-lynch
Copy link
Copy Markdown
Member

Summary

Renames the binary from control-plane to pgedge-control-plane to reduce the chance of conflicts with other packages.

Testing

Dev builds and dist artifacts should continue to work as normal.

PLAT-417

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 9, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5dc02345-98d4-4555-9afc-ec382f239e47

📥 Commits

Reviewing files that changed from the base of the PR and between 40fd983 and ab652f8.

📒 Files selected for processing (10)
  • .gitignore
  • .goreleaser.yaml
  • Makefile
  • docker/control-plane-ci/Dockerfile
  • docker/control-plane-dev/Dockerfile
  • docker/control-plane-dev/docker-compose.yaml
  • docker/control-plane-dev/entrypoint.sh
  • docker/control-plane/Dockerfile
  • docs/development/running-locally.md
  • e2e/fixtures/roles/build_image/vars/main.yaml
✅ Files skipped from review due to trivial changes (9)
  • .gitignore
  • docker/control-plane-dev/Dockerfile
  • docker/control-plane-dev/docker-compose.yaml
  • docs/development/running-locally.md
  • docker/control-plane-ci/Dockerfile
  • .goreleaser.yaml
  • e2e/fixtures/roles/build_image/vars/main.yaml
  • docker/control-plane/Dockerfile
  • docker/control-plane-dev/entrypoint.sh

📝 Walkthrough

Walkthrough

The control-plane executable name was changed project-wide from control-plane to pgedge-control-plane, updating build outputs, release packaging, Docker images/entrypoints, dev compose/watch paths, docs, and archive naming.

Changes

Cohort / File(s) Summary
Ignore rules
\.gitignore
Added pgedge-control-plane to ignore patterns while keeping existing exceptions (e.g., !docker/control-plane).
Release / Build config
\.goreleaser.yaml, Makefile
Renamed project/binary from control-planepgedge-control-plane for goreleaser and Makefile build/release targets and artifact paths.
Docker: CI image
docker/control-plane-ci/Dockerfile
COPY and ENTRYPOINT updated to use /pgedge-control-plane instead of /control-plane.
Docker: Dev image & compose
docker/control-plane-dev/Dockerfile, docker/control-plane-dev/docker-compose.yaml, docker/control-plane-dev/entrypoint.sh
Build copy, host watch/sync paths, and entrypoint execution updated to pgedge-control-plane (both debug and normal modes).
Docker: Release image
docker/control-plane/Dockerfile
Archive extraction name and ENTRYPOINT updated to reference pgedge-control-plane.
Documentation
docs/development/running-locally.md
All user-facing instructions and examples updated to reference pgedge-control-plane instead of control-plane.
E2E fixture / archive naming
e2e/fixtures/roles/build_image/vars/main.yaml
Template _archive_name changed to prefix archives with pgedge- producing pgedge-control-plane_{{ version }}_...tar.gz.

Poem

🐇 I hopped through builds and Docker lanes,
Renamed my coat and changed my gains,
From control-plane to pgedge I prance,
A tiny binary on a big new dance,
Burrito of bytes — a joyous chance! 🎉

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete according to the repository template, missing the Changes section (bulleted list), Testing commands, and most of the Checklist items required for PRs. Add a Changes section with bullet points listing the files modified, provide specific testing commands (e.g., 'make dev-build', 'make goreleaser-build'), and complete the Checklist with details about tests, docs, and changelog entries.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: renaming the binary from 'control-plane' to 'pgedge-control-plane', which aligns with the comprehensive changes across all configuration and Docker files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/PLAT-417/rename-binary

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 06f8903 to 5b65dd1 Compare March 9, 2026 22:00
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from 2934d92 to 9bfda29 Compare March 9, 2026 22:37
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch 4 times, most recently from 3b2cb2d to 1811d33 Compare March 10, 2026 14:33
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from 2000707 to 321ebff Compare March 10, 2026 14:33
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch 3 times, most recently from 1ef89d0 to 32ef891 Compare March 10, 2026 21:01
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from fbd7177 to 818b6cd Compare March 11, 2026 12:58
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 32ef891 to 5c8c403 Compare March 11, 2026 12:58
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from 818b6cd to db06d7c Compare March 11, 2026 13:25
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 5c8c403 to 79fbfc1 Compare March 11, 2026 13:25
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from db06d7c to 94c2dbe Compare March 11, 2026 13:43
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 79fbfc1 to b1b5cae Compare March 11, 2026 13:43
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from 94c2dbe to 1de4ace Compare March 11, 2026 13:49
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from b1b5cae to 3b749f2 Compare March 11, 2026 13:49
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from 1de4ace to 187c000 Compare March 12, 2026 19:28
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 3b749f2 to ccf2e10 Compare March 12, 2026 19:29
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from 187c000 to a6f44f6 Compare March 12, 2026 21:17
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from ccf2e10 to 7607b74 Compare March 12, 2026 21:17
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from a6f44f6 to 2f99484 Compare March 13, 2026 13:13
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 7607b74 to 09c6ec7 Compare March 13, 2026 13:13
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from c8dcd98 to 92554b8 Compare March 23, 2026 21:52
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 6427259 to 2ae3509 Compare March 23, 2026 21:52
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from 92554b8 to b2ab571 Compare March 23, 2026 23:20
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 2ae3509 to 122cbd5 Compare March 23, 2026 23:20
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from b2ab571 to c52c641 Compare March 23, 2026 23:33
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 122cbd5 to 0dd6130 Compare March 23, 2026 23:33
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from c52c641 to f32affe Compare March 23, 2026 23:36
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 0dd6130 to 8e96c53 Compare March 23, 2026 23:36
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from f32affe to ecb25d0 Compare March 24, 2026 00:15
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 8e96c53 to 80a92a0 Compare March 24, 2026 00:15
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from ecb25d0 to 755fb27 Compare March 24, 2026 14:19
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 80a92a0 to 40fd983 Compare March 24, 2026 14:19
@jason-lynch
Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 24, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from 755fb27 to 2379e46 Compare March 24, 2026 18:15
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch 2 times, most recently from 307f1e9 to 6a1d107 Compare March 25, 2026 19:38
@jason-lynch jason-lynch requested a review from rshoemaker March 30, 2026 15:36
Copy link
Copy Markdown
Contributor

@rshoemaker rshoemaker left a comment

Choose a reason for hiding this comment

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

Looks good. I think there are some usages in here that need s/control-plane/pgedge-control-plane/

https://github.com/pgEdge/control-plane/blob/feat/PLAT-417/rename-binary/docs/development/running-locally.md?plain=1

Lines 199, 202, & 205.

@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from 2379e46 to 8ce1172 Compare March 31, 2026 16:43
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 6a1d107 to 8f7d2ca Compare March 31, 2026 16:43
@codacy-production
Copy link
Copy Markdown

codacy-production bot commented Mar 31, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

@jason-lynch jason-lynch force-pushed the feat/PLAT-417/orchestrator-common-resources branch from 8ce1172 to 2058c1f Compare March 31, 2026 16:51
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 8f7d2ca to 8a3fa31 Compare March 31, 2026 16:51
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 31, 2026

Caution

Review failed

An error occurred during the review process. Please try again later.

📝 Walkthrough

Walkthrough

The control-plane executable is being renamed from control-plane to pgedge-control-plane across build configurations, container images, and deployment scripts. This includes updates to build outputs, Dockerfile references, and runtime paths.

Changes

Cohort / File(s) Summary
Build Configuration
.gitignore, .goreleaser.yaml, Makefile
Added pgedge-control-plane to ignore patterns and updated build artifact naming to reflect the new executable name across release packaging and development build targets.
CI Docker Configuration
docker/control-plane-ci/Dockerfile
Updated COPY instruction and ENTRYPOINT to reference the renamed binary pgedge-control-plane instead of control-plane.
Dev Docker Configuration
docker/control-plane-dev/Dockerfile, docker/control-plane-dev/docker-compose.yaml, docker/control-plane-dev/entrypoint.sh
Updated container build instructions, file-watch sync paths, and entrypoint script to use the renamed pgedge-control-plane binary in both DEBUG and standard execution modes.
Release Docker Configuration
docker/control-plane/Dockerfile
Updated ENTRYPOINT to invoke /pgedge-control-plane instead of /control-plane.

Poem

🐇 Our binary hops to a brand new name,
From control-plane to pgedge-control-plane it came,
Through Dockerfiles, compiles, and build-time flame,
A rebranding journey, perfectly tame! 🚀

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is incomplete. While it includes a Summary section explaining the purpose and Testing section describing expected outcomes, it lacks the Changes, Checklist, and Notes for Reviewers sections required by the template. Add the missing sections: provide a bulleted list of high-level changes, complete the pre-merge checklist, and include notes for reviewers if applicable.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat: rename binary to pgedge-control-plane' directly and clearly summarizes the main change across all modified files—renaming the binary artifact throughout the build, deployment, and execution configurations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/PLAT-417/rename-binary

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Base automatically changed from feat/PLAT-417/orchestrator-common-resources to main March 31, 2026 17:34
Renames the binary and archives from `control-plane` to
`pgedge-control-plane` to reduce the chance of conflicts with other
packages.

PLAT-417
@jason-lynch jason-lynch force-pushed the feat/PLAT-417/rename-binary branch from 8a3fa31 to ab652f8 Compare March 31, 2026 17:35
@jason-lynch jason-lynch merged commit 160c4f9 into main Mar 31, 2026
3 checks passed
@jason-lynch jason-lynch deleted the feat/PLAT-417/rename-binary branch March 31, 2026 18:19
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.

2 participants