Rename API server binary from app to ignis - #15
Closed
jravani wants to merge 1 commit into
Closed
Conversation
The HTTP API server binary was named `app`, which is fine inside its own Makefile/Dockerfile context but meaningless once installed alongside other tools (e.g. via go install, which names the binary after its package directory -- cmd/app produced a binary literally called `app`). Moves cmd/app/main.go -> cmd/ignis/main.go and updates every place that builds or runs it: Makefile, Dockerfile, docker-compose.yml, and docs. The ignis-app Docker Compose service/container name is unchanged -- that's the shared <service>-<role> naming convention across the building-simulation namespace (ignis-app, buem-app, etc.), not the compiled binary name, and stays as-is.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Member
Author
|
Superseded by a PR from a correctly-named branch (branch-naming lint requires a / prefix). |
3 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
apptoignis--cmd/appproduced a binary literally calledappundergo install/plaingo build, which is fine standalone but ambiguous once installed next to other tools.cmd/app/main.go->cmd/ignis/main.go.Makefile,environment/Dockerfile,environment/docker-compose.yml,docs/getting-started.md, anddocumentation/content/07-deployment-view.mdto build/runbin/ignisinstead ofbin/app.ignis-appDocker Compose service/container name untouched -- that's the shared<service>-<role>naming convention across thebuilding-simulationnamespace (ignis-app,buem-app, etc.), a different thing from the compiled binary name.build_dbandvalidatebinaries are unchanged.Test plan
go build -o /tmp/ignis-test ./cmd/ignisbuilds cleanlydocker compose up,docker compose exec ignis-app ./bin/ignisstill serves on:8080