Skip to content

Commit adb045d

Browse files
committed
Added minimal task docs.
1 parent c2c2155 commit adb045d

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

src/SshNet.BuildTools.Git/Commit.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55

66
namespace SshNet.BuildTools.Git
77
{
8+
/// <summary>
9+
/// Commits changes in a given Git repository.
10+
/// </summary>
811
public class Commit : Task
912
{
1013
/// <summary>
@@ -32,6 +35,10 @@ public class Commit : Task
3235
/// </value>
3336
[Output]
3437
public string Sha1 { get; set; }
38+
39+
/// <summary>
40+
/// Commits changes in the specified repository.
41+
/// </summary>
3542
public override bool Execute()
3643
{
3744
using (var repo = new Repository(WorkingDirectory))

src/SshNet.BuildTools.Git/Push.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
namespace SshNet.BuildTools.Git
66
{
7+
/// <summary>
8+
/// Pushes changes from a local Git repository to a its remote repository.
9+
/// </summary>
710
public class Push : Task
811
{
912
/// <summary>
@@ -23,6 +26,9 @@ public class Push : Task
2326
/// </value>
2427
public ITaskItem Credentials { get; set; }
2528

29+
/// <summary>
30+
/// Pushes changes from the specified local repository to a its remote repository.
31+
/// </summary>
2632
public override bool Execute()
2733
{
2834
using (var repo = new Repository(WorkingDirectory))

src/SshNet.BuildTools.Git/Stage.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55

66
namespace SshNet.BuildTools.Git
77
{
8+
/// <summary>
9+
/// Promotes changes to the staging area of a given Git repository.
10+
/// </summary>
811
public class Stage : Task
912
{
1013
/// <summary>
@@ -16,6 +19,9 @@ public class Stage : Task
1619
[Required]
1720
public string WorkingDirectory { get; set; }
1821

22+
/// <summary>
23+
/// Stages changes in the specified working directory.
24+
/// </summary>
1925
public override bool Execute()
2026
{
2127
using (var repo = new Repository(WorkingDirectory))

0 commit comments

Comments
 (0)