zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-05-31 10:12:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

rework obsolete warnings to collect a few places previuosly missed and reword to direct users to the new equivalent branch protection methods

Browse Source
This commit is contained in:
Ryan Gribble
2016-08-30 20:43:01 +10:00
parent 4808941c53
commit e6bf4635e9
11 changed files with 27 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableRepositoriesClient.cs
+8 -2
View File
@@ -231,6 +231,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>All <see cref="T:Octokit.Branch"/>es of the repository</returns>
[Obsolete("Please use ObservableRepositoriesClient.Branch.GetAll() instead. This method will be removed in a future version")]
IObservable<Branch> GetAllBranches(string owner, string name);
/// <summary>
@@ -242,6 +243,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The Id of the repository</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>All <see cref="T:Octokit.Branch"/>es of the repository</returns>
[Obsolete("Please use ObservableRepositoriesClient.Branch.GetAll() instead. This method will be removed in a future version")]
IObservable<Branch> GetAllBranches(int repositoryId);
/// <summary>
@@ -255,6 +257,7 @@ namespace Octokit.Reactive
/// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>All <see cref="T:Octokit.Branch"/>es of the repository</returns>
[Obsolete("Please use ObservableRepositoriesClient.Branch.GetAll() instead. This method will be removed in a future version")]
IObservable<Branch> GetAllBranches(string owner, string name, ApiOptions options);
/// <summary>
@@ -267,6 +270,7 @@ namespace Octokit.Reactive
/// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>All <see cref="T:Octokit.Branch"/>es of the repository</returns>
[Obsolete("Please use ObservableRepositoriesClient.Branch.GetAll() instead. This method will be removed in a future version")]
IObservable<Branch> GetAllBranches(int repositoryId, ApiOptions options);
/// <summary>
@@ -480,6 +484,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="branchName">The name of the branch</param>
/// <returns>The specified <see cref="T:Octokit.Branch"/></returns>
[Obsolete("Please use ObservableRepositoriesClient.Branch.Get() instead. This method will be removed in a future version")]
IObservable<Branch> GetBranch(string owner, string name, string branchName);
/// <summary>
@@ -491,6 +496,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="branchName">The name of the branch</param>
/// <returns>The specified <see cref="T:Octokit.Branch"/></returns>
[Obsolete("Please use ObservableRepositoriesClient.Branch.Get() instead. This method will be removed in a future version")]
IObservable<Branch> GetBranch(int repositoryId, string branchName);
/// <summary>
@@ -518,7 +524,7 @@ namespace Octokit.Reactive
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
/// <returns>The updated <see cref="T:Octokit.Branch"/></returns>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the ObservableRepositoryBranchesClient methods instead.")]
IObservable<Branch> EditBranch(string owner, string name, string branch, BranchUpdate update);
/// <summary>
@@ -528,7 +534,7 @@ namespace Octokit.Reactive
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
/// <returns>The updated <see cref="T:Octokit.Branch"/></returns>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the ObservableRepositoryBranchesClient methods instead.")]
IObservable<Branch> EditBranch(int repositoryId, string branch, BranchUpdate update);
/// <summary>
Octokit.Reactive/Clients/IObservableRepositoryBranchesClient.cs
+2 -2
View File
@@ -81,7 +81,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other ObservableRepositoryBranchesClient methods instead.")]
IObservable<Branch> Edit(string owner, string name, string branch, BranchUpdate update);
/// <summary>
@@ -90,7 +90,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other ObservableRepositoryBranchesClient methods instead.")]
IObservable<Branch> Edit(int repositoryId, string branch, BranchUpdate update);
/// <summary>
Octokit.Reactive/Clients/ObservableRepositoriesClient.cs
+2 -2
View File
@@ -778,7 +778,7 @@ namespace Octokit.Reactive
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
/// <returns>The updated <see cref="T:Octokit.Branch"/></returns>
[Obsolete("Please use RepositoriesClient.Branch.Edit() instead. This method will be removed in a future version")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the ObservableRepositoryBranchesClient methods instead.")]
public IObservable<Branch> EditBranch(string owner, string name, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -796,7 +796,7 @@ namespace Octokit.Reactive
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
/// <returns>The updated <see cref="T:Octokit.Branch"/></returns>
[Obsolete("Please use RepositoriesClient.Branch.Edit() instead. This method will be removed in a future version")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the ObservableRepositoryBranchesClient methods instead.")]
public IObservable<Branch> EditBranch(int repositoryId, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(branch, "branch");
Octokit.Reactive/Clients/ObservableRepositoryBranchesClient.cs
+2 -2
View File
@@ -122,7 +122,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other ObservableRepositoryBranchesClient methods instead.")]
public IObservable<Branch> Edit(string owner, string name, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -139,7 +139,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other ObservableRepositoryBranchesClient methods instead.")]
public IObservable<Branch> Edit(int repositoryId, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(branch, "branch");
Octokit/Clients/IRepositoriesClient.cs
+2 -2
View File
@@ -627,7 +627,7 @@ namespace Octokit
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
/// <returns>The updated <see cref="T:Octokit.Branch"/></returns>
[Obsolete("Please use RepositoriesClient.Branch.Edit() instead. This method will be removed in a future version")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the RepositoryBranchesClient methods instead.")]
Task<Branch> EditBranch(string owner, string name, string branch, BranchUpdate update);
/// <summary>
@@ -637,7 +637,7 @@ namespace Octokit
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
/// <returns>The updated <see cref="T:Octokit.Branch"/></returns>
[Obsolete("Please use RepositoriesClient.Branch.Edit() instead. This method will be removed in a future version")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the RepositoryBranchesClient methods instead.")]
Task<Branch> EditBranch(int repositoryId, string branch, BranchUpdate update);
/// <summary>
Octokit/Clients/IRepositoryBranchesClient.cs
+2 -2
View File
@@ -86,7 +86,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other RepositoryBranchesClient methods instead.")]
Task<Branch> Edit(string owner, string name, string branch, BranchUpdate update);
/// <summary>
@@ -95,7 +95,7 @@ namespace Octokit
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other RepositoryBranchesClient methods instead.")]
Task<Branch> Edit(int repositoryId, string branch, BranchUpdate update);
/// <summary>
Octokit/Clients/RepositoriesClient.cs
+2 -2
View File
@@ -216,7 +216,7 @@ namespace Octokit
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
/// <returns>The updated <see cref="T:Octokit.Branch"/></returns>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the RepositoryBranchesClient methods instead.")]
public Task<Branch> EditBranch(string owner, string name, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -234,7 +234,7 @@ namespace Octokit
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
/// <returns>The updated <see cref="T:Octokit.Branch"/></returns>
[Obsolete("Please use RepositoriesClient.Branch.Edit() instead. This method will be removed in a future version")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the RepositoryBranchesClient methods instead.")]
public Task<Branch> EditBranch(int repositoryId, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(branch, "branch");
Octokit/Clients/RepositoryBranchesClient.cs
+2 -2
View File
@@ -124,7 +124,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other RepositoryBranchesClient methods instead.")]
public Task<Branch> Edit(string owner, string name, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -141,7 +141,7 @@ namespace Octokit
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="branch">The name of the branch</param>
/// <param name="update">New values to update the branch with</param>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other RepositoryBranchesClient methods instead.")]
public Task<Branch> Edit(int repositoryId, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(branch, "branch");
Octokit/Models/Request/BranchUpdate.cs
+1 -1
View File
@@ -11,7 +11,7 @@ namespace Octokit
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/
/// </remarks>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use BranchProtectionSettingsUpdate instead.")]
public class BranchUpdate
{
/// <summary>
Octokit/Models/Response/Branch.cs
+1 -1
View File
@@ -39,7 +39,7 @@ namespace Octokit
/// <summary>
/// The <see cref="BranchProtection"/> details for this <see cref="Branch"/>.
/// </summary>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.", false)]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please see the Branch.Protected property and RepositoryBranchesClient.GetBranchProtection method instead.")]
public BranchProtection Protection { get; protected set; }
/// <summary>
Octokit/Models/Response/BranchProtection.cs
+3 -3
View File
@@ -14,7 +14,7 @@ namespace Octokit
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/
/// </remarks>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please see BranchProtectionSettings instead.")]
public class BranchProtection
{
public BranchProtection() { }
@@ -45,7 +45,7 @@ namespace Octokit
}
[DebuggerDisplay("{DebuggerDisplay,nq}")]
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please see BranchProtectionRequiredStatusChecks instead.")]
public class RequiredStatusChecks
{
public RequiredStatusChecks() { }
@@ -78,7 +78,7 @@ namespace Octokit
/// <summary>
/// The enforcement levels that are available
/// </summary>
[Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")]
[Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please see BranchProtectionRequiredStatusChecks.IncludeAdmins instead.")]
public enum EnforcementLevel
{
/// <summary>