honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(dev-infra): update jsdoc comments to reflect recent code changes (#41688) 

PR Close #41688
This commit is contained in:
George Kalpakas 2021-04-18 12:45:45 +03:00 committed by Andrew Kushnir
parent 5ba77f4f6a
commit 8058396c52
2 changed files with 8 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
dev-infra/ng-dev.js
View File

@ -4276,9 +4276,7 @@ var PullRequestMergeTask = /** @class */ (function () {
* See {@link GithubApiMergeStrategy} and {@link AutosquashMergeStrategy} * See {@link GithubApiMergeStrategy} and {@link AutosquashMergeStrategy}
* *
* @param prNumber Number of the pull request that should be merged. * @param prNumber Number of the pull request that should be merged.
* @param githubToken Github token used for merging (i.e. fetching and pushing) * @param flags Configuration options for merging pull requests.
* @param projectRoot Path to the local Git project that is used for merging.
* @param config Configuration for merging pull requests.
*/ */
function mergePullRequest(prNumber, flags) { function mergePullRequest(prNumber, flags) {
return tslib.__awaiter(this, void 0, void 0, function () { return tslib.__awaiter(this, void 0, void 0, function () {
@ -4413,9 +4411,9 @@ function mergePullRequest(prNumber, flags) {
}); });
} }
/** /**
* Creates the pull request merge task from the given Github token, project root * Creates the pull request merge task using the given configuration options. Explicit configuration
* and optional explicit configuration. An explicit configuration can be specified * options can be specified when the merge script is used outside of an `ng-dev` configured
* when the merge script is used outside of a `ng-dev` configured repository. * repository.
*/ */
function createPullRequestMergeTask(flags) { function createPullRequestMergeTask(flags) {
return tslib.__awaiter(this, void 0, void 0, function () { return tslib.__awaiter(this, void 0, void 0, function () {

10
dev-infra/pr/merge/index.ts
View File

@ -25,9 +25,7 @@ import {MergeResult, MergeStatus, PullRequestMergeTask, PullRequestMergeTaskFlag
* See {@link GithubApiMergeStrategy} and {@link AutosquashMergeStrategy} * See {@link GithubApiMergeStrategy} and {@link AutosquashMergeStrategy}
* *
* @param prNumber Number of the pull request that should be merged. * @param prNumber Number of the pull request that should be merged.
* @param githubToken Github token used for merging (i.e. fetching and pushing) * @param flags Configuration options for merging pull requests.
* @param projectRoot Path to the local Git project that is used for merging.
* @param config Configuration for merging pull requests.
*/ */
export async function mergePullRequest(prNumber: number, flags: PullRequestMergeTaskFlags) { export async function mergePullRequest(prNumber: number, flags: PullRequestMergeTaskFlags) {
// Set the environment variable to skip all git commit hooks triggered by husky. We are unable to // Set the environment variable to skip all git commit hooks triggered by husky. We are unable to
@ -122,9 +120,9 @@ export async function mergePullRequest(prNumber: number, flags: PullRequestMerge
} }
/** /**
* Creates the pull request merge task from the given Github token, project root * Creates the pull request merge task using the given configuration options. Explicit configuration
* and optional explicit configuration. An explicit configuration can be specified * options can be specified when the merge script is used outside of an `ng-dev` configured
* when the merge script is used outside of a `ng-dev` configured repository. * repository.
*/ */
async function createPullRequestMergeTask(flags: PullRequestMergeTaskFlags) { async function createPullRequestMergeTask(flags: PullRequestMergeTaskFlags) {
const devInfraConfig = getConfig(); const devInfraConfig = getConfig();