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

Add conan badge #795

Merged
merged 4 commits into from Mar 25, 2023
Merged

Add conan badge #795

merged 4 commits into from Mar 25, 2023

Conversation

MartinDelille
Copy link
Contributor

Since your project is available on the conan center, what about advertizing it on the README.md ?

@supervacuus
Copy link
Collaborator

Thx @MartinDelille! I am fine with adding this. I would personally prefer to have all up-to-date package managers referenced, but there isn't even a shields.io badge for vcpkg.

I looked into meta-package-manager badge-providers once and it seems repology` would answer that, but since it is syncing on the repositories of packages, a badge leads you only there and not to the "official" listing of the respective package-manager.

I know that previously there was opposition to advertising packages not maintained by sentry, so I am looping in @Swatinem and @ashwoods (cc @bitsandfoxes, @markushi) to maybe voice any official position.

@Swatinem
Copy link
Member

Swatinem commented Feb 6, 2023

I believe it might be worth adding badges, maybe even a repology overview.

However it would also be a good idea to highlight that these are third party distributions not maintained directly by our team. Though not quite sure if any other open source project does that which is being packaged into various package archives that are not maintained by the original developers?

@supervacuus
Copy link
Collaborator

Though not quite sure if any other open source project does that which is being packaged into various package archives that are not maintained by the original developers?

That is a good question, indeed. For most package managers that aren't an integral component of the build tooling in a particular ecosystem, the package maintainer != the source maintainer. I cannot judge how much additional (support) effort advertising would mean on our side, but since we aren't advertising right now and still quite a few people are using vcpkg and conan, my guess is, that we can't really limit their use either.

A more positive interpretation would be, that we can consider any packaging as further bounds on the correct build and export of our artifacts and via open-source package repos we at least have insight into how the Native SDK is built and integrated for some of its users. In the worst case we might have to ask a user to file an issue with the respective package maintainers (which could come back to us, making it a good case again ;) ).

Well, and there are some hard boundaries in which neither breakpad nor crashpad work (any distribution mechanism where we end up in a sandbox that prevents ptrace to run for instance).

I also found that repology has "tiny badges", so we could combine shields.io badges with those... or use the repology badges for all but link to the official package-manager site for those that provide an addressable resource on their website.

Copy link
Collaborator

@supervacuus supervacuus left a comment

Choose a reason for hiding this comment

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

Since shields.io currently doesn't support vcpkg, I would replace the badge with a repology badge (but let it link to Conan Center instead of the GitHub repo) and add the other two repositories that currently host a recent version of the Native SDK. Please also add a short entry to the changelog. Thx!

README.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Mar 21, 2023

Codecov Report

Merging #795 (5918431) into master (903c17a) will decrease coverage by 5.56%.
The diff coverage is n/a.

❗ Current head 5918431 differs from pull request most recent head b0ac70e. Consider uploading reports for the commit b0ac70e to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #795      +/-   ##
==========================================
- Coverage   86.71%   81.16%   -5.56%     
==========================================
  Files          40       53      +13     
  Lines        3448     6981    +3533     
  Branches        0     1119    +1119     
==========================================
+ Hits         2990     5666    +2676     
- Misses        458     1204     +746     
- Partials        0      111     +111     

@njakob
Copy link

njakob commented Mar 25, 2023

Vcpkg badge support was added to shields.io last month through badges/shields#8923 @supervacuus. Therefore, we could imagine having both Conan and Vcpkg versions!

Vcpkg Version

Since you could only directly link the port files in Vcpkg GitHub repository, the example above contains the detailed page on Vcpkg.link which has much more details.

MartinDelille and others added 4 commits March 25, 2023 21:33
Co-authored-by: Mischan Toosarani-Hausberger <mischan@abovevacant.com>
@supervacuus supervacuus merged commit 694f055 into getsentry:master Mar 25, 2023
17 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

4 participants