Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split shotover library/binary into separate crates #1102

Merged
merged 2 commits into from Mar 29, 2023

Conversation

rukai
Copy link
Member

@rukai rukai commented Mar 27, 2023

Naming is up for discussion but I am proposing:

  • shotover the library is called shotover
    • Shorter to write when referring to in the application/custom transform code
  • shotover the binary is called shotover-proxy
    • Name is unique from the library, allows for distinguishing between lib and bin in both human discussion and also within cargo. For example users of custom transforms will now be able to name their binary shotover-proxy to match upstream if they desire, previously that was impossible because of the collision with the library name.

The shotover library will contain all of shotover, the shotover-proxy binary is just there to statically link in custom transforms.

Alternatives:

Shotover the product is called just "shotover" instead of "shotover proxy" these days.
So the -proxy postfix doesnt mean as much, maybe we should go for something more descriptive like shotover-bin?

@conorbros
Copy link
Member

+1 for shotover-bin

Copy link
Member

@benbromhead benbromhead left a comment

Choose a reason for hiding this comment

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

+1 shotover-bin

@rukai
Copy link
Member Author

rukai commented Mar 29, 2023

The people have spoken!
Once this lands I'll do a follow up PR for shotover-proxy -> shotover-bin

@rukai rukai enabled auto-merge (squash) March 29, 2023 06:13
@rukai rukai merged commit 600818f into shotover:main Mar 29, 2023
9 checks passed
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.

None yet

3 participants