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

[eljonny-testcpp]: new port #37471

Draft
wants to merge 11 commits into
base: master
Choose a base branch
from
Draft

[eljonny-testcpp]: new port #37471

wants to merge 11 commits into from

Conversation

eljonny
Copy link

@eljonny eljonny commented Mar 15, 2024

I would like to add my library TestCPP to the public vcpkg registry.
It is a very simple C++ testing framework that can be useful for small or educational projects.

  • Changes comply with the maintainer guide.
  • The name of the port matches an existing name for this component on https://repology.org/ if possible, and/or is strongly associated with that component on search engines.
  • Optional dependencies are resolved in exactly one way. For example, if the component is built with CMake, all find_package calls are REQUIRED, are satisfied by vcpkg.json's declared dependencies, or disabled with CMAKE_DISABLE_FIND_PACKAGE_Xxx.
  • The versioning scheme in vcpkg.json matches what upstream says.
  • The license declaration in vcpkg.json matches what upstream says.
  • The installed as the "copyright" file matches what upstream says.
  • The source code of the component installed comes from an authoritative source.
  • The generated "usage text" is accurate. See adding-usage for context.
  • The version database is fixed by rerunning ./vcpkg x-add-version --all and committing the result.
  • Only one version is in the new port's versions file.
  • Only one version is added to each modified port's versions file.

@WangWeiLin-MV WangWeiLin-MV added the category:new-port The issue is requesting a new library to be added; consider making a PR! label Mar 15, 2024
@eljonny
Copy link
Author

eljonny commented Mar 15, 2024

@microsoft-github-policy-service agree

@eljonny
Copy link
Author

eljonny commented Mar 15, 2024

I am concerned that since my package does not exist on repology.org.
Since it is quite new to GitHub and the internet (I hadn't published the source to a public repository previous to creating the repo in my GitHub) it is not yet easily found on search engines.
So I really can't check the 2nd box off on the checklist. Is that going to block my PR from being approved?

TestCPP is a personal project I wrote many years ago that I am coming back to, as I am looking to improve it and add it to current C++ package registries, which I had not done previously.
There appears to be a similarly named test framework on GitHub called test-cpp, but it appears to be abandoned as it has not been updated for about 10 years. Would this be considered a naming conflict? If so I can rename my package since this is the first time I'm actually publishing it.

Thanks so much for looking at my request.
Jonathan

@BillyONeal BillyONeal changed the title Test cpp Test cpp: new port Mar 18, 2024
@BillyONeal
Copy link
Member

Web search for this name first hit is https://github.com/mrts/test-cpp

Would you accept eljonny-testcpp?

@BillyONeal
Copy link
Member

Also, Test.h and tests.hpp are likely to conflict with other users. Can you install those to a subdirectory?

@eljonny
Copy link
Author

eljonny commented Mar 19, 2024

I'll work out a different name for the package.
The test.hpp file is totally local to the project and is used for the demo application that users can build when learning the library. Test.h goes into a subdirectory called TestCPP when installed; so it will go to /install/prefix/include/TestCPP/Test.h.
Is this ok?
I appreciate you checking out my PR! Thank you!

@eljonny
Copy link
Author

eljonny commented Mar 19, 2024

Would the name basictestcpp be ok?
It looks like that one comes back pretty empty on search.
If this is ok I'll fix that up, if not I'll use eljonny-testcpp.
Thanks again!

@BillyONeal
Copy link
Member

Test.h goes into a subdirectory called TestCPP when installed; so it will go to /install/prefix/include/TestCPP/Test.h.

This is fine if we keep the name TestCPP. If so your documentation should tell people to do #include <TestCPP/Test.h>

Would the name basictestcpp be ok?
It looks like that one comes back pretty empty on search.
If this is ok I'll fix that up, if not I'll use eljonny-testcpp.

To be clear, the check is not 'is that name unused', it is 'is that name strongly associated with that already'. With the overall goal being that someone doing vcpkg install name getting what they expect name to mean.

@BillyONeal BillyONeal added the requires:vcpkg-team-review This PR or issue requires someone on the vcpkg team to take a further look. label Mar 23, 2024
@BillyONeal
Copy link
Member

I'll ask other maintainers but eljonny-testcpp would be ideal as following GitHub's names are ~always acceptable.

@eljonny
Copy link
Author

eljonny commented Mar 23, 2024

Test.h goes into a subdirectory called TestCPP when installed; so it will go to /install/prefix/include/TestCPP/Test.h.

This is fine if we keep the name TestCPP. If so your documentation should tell people to do #include <TestCPP/Test.h>

This information is indeed currently in the docs (README.md in the repo).
I don't have any intention of changing the actual library name.
If I were to change the package name, would adding the package to vcpkg require me to rename the actual library?

Would the name basictestcpp be ok?

It looks like that one comes back pretty empty on search.

If this is ok I'll fix that up, if not I'll use eljonny-testcpp.

To be clear, the check is not 'is that name unused', it is 'is that name strongly associated with that already'. With the overall goal being that someone doing vcpkg install name getting what they expect name to mean.

Ahhh ok I understand. This makes sense. I'm more than happy changing the package name to eljonny-testcpp.

@eljonny
Copy link
Author

eljonny commented Mar 23, 2024

I'll ask other maintainers but eljonny-testcpp would be ideal as following GitHub's names are ~always acceptable.

I will rename the package to eljonny-testcpp. This is no biggie. Thank you for all your input and info!

@BillyONeal BillyONeal removed the requires:vcpkg-team-review This PR or issue requires someone on the vcpkg team to take a further look. label Mar 28, 2024
@BillyONeal BillyONeal changed the title Test cpp: new port [eljonny-testcpp]: new port Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category:new-port The issue is requesting a new library to be added; consider making a PR!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants