Skip to content

Commit

Permalink
(cake-buildGH-2652) Improve documentation for TFBuildPullRequestInfo.…
Browse files Browse the repository at this point in the history
…Id and TFBuildPullRequestInfo.Number
  • Loading branch information
pascalberger committed Oct 30, 2019
1 parent 4f34379 commit 7c4feb5
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/Cake.Common/Build/TFBuild/Data/TFBuildPullRequestInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,20 @@ public TFBuildPullRequestInfo(ICakeEnvironment environment)
public bool IsPullRequest => Id > 0;

/// <summary>
/// Gets the pull request id.
/// Gets the ID of the pull request that caused this build.
/// This value is set only if the build ran because of a Git PR affected by a branch policy.
/// </summary>
/// <value>
/// The pull request id.
/// The ID of the pull request that caused this build.
/// </value>
public int Id => GetEnvironmentInteger("SYSTEM_PULLREQUEST_PULLREQUESTID");

/// <summary>
/// Gets the GitHub pull request number.
/// Gets the number of the pull request that caused this build.
/// This value is set for pull requests from GitHub which have a different pull request ID and pull request number.
/// </summary>
/// <value>
/// The GitHub pull request number.
/// The number of the pull request that caused this build.
/// </value>
public int Number => GetEnvironmentInteger("SYSTEM_PULLREQUEST_PULLREQUESTNUMBER");

Expand Down

0 comments on commit 7c4feb5

Please sign in to comment.