zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-05-29 09:22:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1428 from TattsGroup/protected-branches-obsolete

Browse Source 
Flag obsolete warnings for initial Protected Branch API preview functionality
This commit is contained in:
Brendan Forster
2016-07-22 09:52:41 -07:00
committed by GitHub
parent bc1967b98f ba127b21a8
commit e3fd99ea9d
7 changed files with 17 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableRepositoriesClient.cs
+2
View File
@@ -509,6 +509,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.")]
IObservable<Branch> EditBranch(string owner, string name, string branch, BranchUpdate update);
/// <summary>
@@ -518,6 +519,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.")]
IObservable<Branch> EditBranch(int repositoryId, string branch, BranchUpdate update);
/// <summary>
Octokit.Reactive/Clients/ObservableRepositoriesClient.cs
+2
View File
@@ -769,6 +769,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.")]
public IObservable<Branch> EditBranch(string owner, string name, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -786,6 +787,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.")]
public IObservable<Branch> EditBranch(int repositoryId, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(branch, "branch");
Octokit/Clients/IRepositoriesClient.cs
+2
View File
@@ -612,6 +612,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.")]
Task<Branch> EditBranch(string owner, string name, string branch, BranchUpdate update);
/// <summary>
@@ -621,6 +622,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.")]
Task<Branch> EditBranch(int repositoryId, string branch, BranchUpdate update);
/// <summary>
Octokit/Clients/RepositoriesClient.cs
+2
View File
@@ -213,6 +213,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.")]
public Task<Branch> EditBranch(string owner, string name, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -230,6 +231,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.")]
public Task<Branch> EditBranch(int repositoryId, string branch, BranchUpdate update)
{
Ensure.ArgumentNotNullOrEmptyString(branch, "branch");
Octokit/Models/Request/BranchUpdate.cs
+1
View File
@@ -9,6 +9,7 @@ namespace Octokit
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/
/// </summary>
[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.")]
public class BranchUpdate
{
/// <summary>
Octokit/Models/Response/Branch.cs
+5 -1
View File
@@ -1,4 +1,5 @@
using System.Diagnostics;
using System;
using System.Diagnostics;
using System.Globalization;
namespace Octokit
@@ -8,12 +9,14 @@ namespace Octokit
{
public Branch() { }
#pragma warning disable CS0618 // Type or member is obsolete
public Branch(string name, GitReference commit, BranchProtection protection)
{
Name = name;
Commit = commit;
Protection = protection;
}
#pragma warning restore CS0618 // Type or member is obsolete
/// <summary>
/// Name of this <see cref="Branch"/>.
@@ -24,6 +27,7 @@ namespace Octokit
/// The <see cref="BranchProtection"/> details for this <see cref="Branch"/>.
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/
/// </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)]
public BranchProtection Protection { get; protected set; }
/// <summary>
Octokit/Models/Response/BranchProtection.cs
+3
View File
@@ -12,6 +12,7 @@ namespace Octokit
/// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/
/// </summary>
[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.")]
public class BranchProtection
{
public BranchProtection() { }
@@ -42,6 +43,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.")]
public class RequiredStatusChecks
{
public RequiredStatusChecks() { }
@@ -74,6 +76,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.")]
public enum EnforcementLevel
{
/// <summary>