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

[Issue] I'd like to fix all of the Async naming conventions to ensure the suffix 'Async' is added wherever possible #5

Open
jeffward01 opened this issue Oct 13, 2022 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@jeffward01
Copy link
Collaborator

Hello,

I'd like to fix all the async methods and ensure all async methods end with the suffix Async - I will also add a CancellationToken cancellationToken = default); wherever possible.

This will be a breaking change as it changes all of the existing Method names.

I suggest that we do (1) of (2) things:

Option 1: Create duplicate methods with the suffix Async then mark the existing methods as [Obsolete] Iterate the version of Revoke.NET from 2.0.1 to 2.1.0`

When it comes time to release 3.0.0 we will remove the [Obsolete] methods

This option is safer, but more painful for development reasons that are obvious.

Option 2: Iterate to version 3.0.0 with the new Suffix of Async - this will be a breaking change. Users who wish to stay on version 2.x.x can do so.


My thoughts are that this is a younger project, so probably not many users, I vote for Option 2

What do you think?

@rainxh11
Copy link
Owner

Option 1 is better

@jeffward01
Copy link
Collaborator Author

Sounds good, i'll get started on Option 1 and make a pull request.

I will reach out if I have any questions.

Safer is always better 😄 thanks for the quick input 🚀

@jeffward01 jeffward01 self-assigned this Oct 13, 2022
@jeffward01 jeffward01 added the enhancement New feature or request label Oct 13, 2022
@jeffward01
Copy link
Collaborator Author

Hello!

I started to implement this here: https://github.com/jeffward01/Revoke.NET/tree/async-suffix

I noticed that the other projects rely on Revoke.Net version 2.0.1 from Nuget.

We could do something like:

Publish new version of Revoke.Net with the async methods to nuget: version 2.0.2 as an example,
Then after its 'live', I can work on upgrading the other projects.


What do you think?

If this is ok, I have made my PR, please publish the version to nuget, so I can start on converting the other projects.

You'll need to:

  • Accept the PR
  • Update the version number
  • Create a new release
  • Publish to nuget

Is this ok?


Question:

  • Do you think they'll be any issues with the other projects? I think no, because the other projects will target 2.0.1, not 2.0.2.
    Thanks

@jeffward01
Copy link
Collaborator Author

jeffward01 commented Jan 11, 2023

I didn't realize I had Collaborator rights, thank you!! Very excited to help on this library. You are awesome.

I looked to see if I could perform the steps

  • Accept the PR
  • Update the version number
  • Create a new release
  • Publish to nuget

But it appears as if you don't have a GitHub Action / Trigger set up, so I am assuming you manually deploy the package to Nuget?

At a time in the near future I can implement a Github Action trigger, I will just need you to popular a repository variable (I wont have access to it) with your Nuget API token.

Here is a tutorial on how you can set up the API key. There are many other tutorials that you can review as well. Let me know if you need any help with this. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants