BenFradet / RiotSharp

C# wrapper for the Riot Games API
http://benfradet.github.io/RiotSharp/
MIT License
300 stars 145 forks source link

Nuget Publishing #696

Open xXLAOKOONXx opened 3 years ago

xXLAOKOONXx commented 3 years ago

Currently the publishing of nuget packages is a manual task reducing the agility and user experience of this wrapper.

"nuget publishing is currenly broken and we'd need someone to take it over." - BenFradet (https://github.com/BenFradet/RiotSharp/issues/684#issuecomment-863869143)

Does this mean someone needs to implement the pipeline or take over the complete process or project? I experimented a bit with nuget and github actions to create a pipeline that on tag/release creation is able to build and publish a nuget package. If this sounds good, I can write an action for RiotSharp. (I would need a nuget key for nuget publishing in the project secrets for the pipe to work, I can give more detailed explaination if this is the way to go.)

BenFradet commented 3 years ago

I experimented a bit with nuget and github actions to create a pipeline that on tag/release creation is able to build and publish a nuget package. If this sounds good, I can write an action for RiotSharp.

This sounds good :+1:

xXLAOKOONXx commented 3 years ago

Short Update:

Due to my match-v5 implementation the tests are outdated and throw errors, therefore I could not include them. To include testing that requires an api key a permanent key might be stored in repository secrets, but this is another topic.

xXLAOKOONXx commented 3 years ago

image There is the option to push the build nuget package onto github as well. It will appear in the 'packages' section (see in bot right of screenshot)

xXLAOKOONXx commented 3 years ago

Implementation finished. please check the markdown file and add nuget api key to secrets.

xXLAOKOONXx commented 3 years ago

Implementation done and merged. @BenFradet Can you try a release to check whther is working accordingly? There should be two new commits regarding match v5 not included in 5.0.0-alpha.

BenFradet commented 3 years ago

yes I'll try on Monday I think :+1:

xXLAOKOONXx commented 3 years ago

Want to reask about trying setting a new Release. :)

BenFradet commented 3 years ago

oops sorry, I'm on holidays starting next week. I should have more time then :+1:

bugproof commented 3 years ago

@xXLaokoonXx I switched to https://github.com/MingweiSamuel/Camille The DX is much better and the API in overall seems more consistent and feels nicer. Doesn't throw exceptions for 404 errors but returns null instead (better performance wise) and many other advantages over this library. The author also maintains Rust's version which is nice.

xXLAOKOONXx commented 2 years ago

As you can see in #706 the installation of riotsharp is a barrier for using the framework.

If you have any questions or my documentation is not descriptive enough hit me up.