From 5c2912f0d13386fc5ca8c7548503f336a05e03ab Mon Sep 17 00:00:00 2001 From: Matthias Koch Date: Sat, 6 May 2023 17:09:14 +0200 Subject: [PATCH] Fix XML documentation --- .../CI/GitHubActions/GitHubActions.cs | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/source/Nuke.Common/CI/GitHubActions/GitHubActions.cs b/source/Nuke.Common/CI/GitHubActions/GitHubActions.cs index 8349bcc15..c17ce2168 100644 --- a/source/Nuke.Common/CI/GitHubActions/GitHubActions.cs +++ b/source/Nuke.Common/CI/GitHubActions/GitHubActions.cs @@ -57,7 +57,7 @@ internal GitHubActions() string IBuildServer.Branch => Ref; string IBuildServer.Commit => Sha; - ///The path to the GitHub home directory used to store user data. For example, /github/home. + ///The path to the GitHub home directory used to store user data. For example, /github/home. public string Home => EnvironmentInfo.GetVariable("HOME"); ///The name of the workflow. @@ -66,31 +66,31 @@ internal GitHubActions() ///The name of the action. public string Action => EnvironmentInfo.GetVariable("GITHUB_ACTION"); - ///The name of the person or app that initiated the workflow. For example, octocat. + ///The name of the person or app that initiated the workflow. For example, octocat. public string Actor => EnvironmentInfo.GetVariable("GITHUB_ACTOR"); - ///The owner and repository name. For example, octocat/Hello-World. + ///The owner and repository name. For example, octocat/Hello-World. public string Repository => EnvironmentInfo.GetVariable("GITHUB_REPOSITORY"); - ///The owner name. For example, octocat. + ///The owner name. For example, octocat. public string RepositoryOwner => EnvironmentInfo.GetVariable("GITHUB_REPOSITORY_OWNER"); ///The name of the webhook event that triggered the workflow. public string EventName => EnvironmentInfo.GetVariable("GITHUB_EVENT_NAME"); - ///The path of the file with the complete webhook event payload. For example, /github/workflow/event.json. + ///The path of the file with the complete webhook event payload. For example, /github/workflow/event.json. public string EventPath => EnvironmentInfo.GetVariable("GITHUB_EVENT_PATH"); - ///The GitHub workspace directory path. The workspace directory contains a subdirectory with a copy of your repository if your workflow uses the actions/checkout action. If you don't use the actions/checkout action, the directory will be empty. For example, /home/runner/work/my-repo-name/my-repo-name. + ///The GitHub workspace directory path. The workspace directory contains a subdirectory with a copy of your repository if your workflow uses the actions/checkout action. If you don't use the actions/checkout action, the directory will be empty. For example, /home/runner/work/my-repo-name/my-repo-name. public string Workspace => EnvironmentInfo.GetVariable("GITHUB_WORKSPACE"); - ///The commit SHA that triggered the workflow. For example, ffac537e6cbbf934b08745a378932722df287a53. + ///The commit SHA that triggered the workflow. For example, ffac537e6cbbf934b08745a378932722df287a53. public string Sha => EnvironmentInfo.GetVariable("GITHUB_SHA"); - ///The fully-formed ref of the branch or tag that triggered the workflow run. For workflows triggered by push, this is the branch or tag ref that was pushed. For workflows triggered by pull_request, this is the pull request merge branch. For workflows triggered by release, this is the release tag created. For other triggers, this is the branch or tag ref that triggered the workflow run. This is only set if a branch or tag is available for the event type. The ref given is fully-formed, meaning that for branches the format is refs/heads/<branch_name>, for pull requests it is refs/pull/<pr_number>/merge, and for tags it is refs/tags/<tag_name>. For example, refs/heads/feature-branch-1. + ///The fully-formed ref of the branch or tag that triggered the workflow run. For workflows triggered by push, this is the branch or tag ref that was pushed. For workflows triggered by pull_request, this is the pull request merge branch. For workflows triggered by release, this is the release tag created. For other triggers, this is the branch or tag ref that triggered the workflow run. This is only set if a branch or tag is available for the event type. The ref given is fully-formed, meaning that for branches the format is refs/heads/<branch_name>, for pull requests it is refs/pull/<pr_number>/merge, and for tags it is refs/tags/<tag_name>. For example, refs/heads/feature-branch-1. public string Ref => EnvironmentInfo.GetVariable("GITHUB_REF"); - ///The short ref name of the branch or tag that triggered the workflow run. This value matches the branch or tag name shown on GitHub. For example, feature-branch-1. + ///The short ref name of the branch or tag that triggered the workflow run. This value matches the branch or tag name shown on GitHub. For example, feature-branch-1. public string RefName => EnvironmentInfo.GetVariable("GITHUB_REF_NAME"); ///Only set for forked repositories. The branch of the head repository. @@ -99,7 +99,7 @@ internal GitHubActions() ///Only set for forked repositories. The branch of the base repository. public string BaseRef => EnvironmentInfo.GetVariable("GITHUB_BASE_REF"); - ///The type of ref that triggered the workflow run. Valid values are branch or tag. + ///The type of ref that triggered the workflow run. Valid values are branch or tag. public string RefType => EnvironmentInfo.GetVariable("GITHUB_REF_TYPE"); public long RunAttempt => EnvironmentInfo.GetVariable("GITHUB_RUN_ATTEMPT");