docs(dev-infra): update jsdoc comments to reflect recent code changes (#41688)
PR Close #41688
This commit is contained in:
parent
5ba77f4f6a
commit
8058396c52
|
@ -4276,9 +4276,7 @@ var PullRequestMergeTask = /** @class */ (function () {
|
|||
* See {@link GithubApiMergeStrategy} and {@link AutosquashMergeStrategy}
|
||||
*
|
||||
* @param prNumber Number of the pull request that should be merged.
|
||||
* @param githubToken Github token used for merging (i.e. fetching and pushing)
|
||||
* @param projectRoot Path to the local Git project that is used for merging.
|
||||
* @param config Configuration for merging pull requests.
|
||||
* @param flags Configuration options for merging pull requests.
|
||||
*/
|
||||
function mergePullRequest(prNumber, flags) {
|
||||
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
|
||||
* and optional explicit configuration. An explicit configuration can be specified
|
||||
* when the merge script is used outside of a `ng-dev` configured repository.
|
||||
* Creates the pull request merge task using the given configuration options. Explicit configuration
|
||||
* options can be specified when the merge script is used outside of an `ng-dev` configured
|
||||
* repository.
|
||||
*/
|
||||
function createPullRequestMergeTask(flags) {
|
||||
return tslib.__awaiter(this, void 0, void 0, function () {
|
||||
|
|
|
@ -25,9 +25,7 @@ import {MergeResult, MergeStatus, PullRequestMergeTask, PullRequestMergeTaskFlag
|
|||
* See {@link GithubApiMergeStrategy} and {@link AutosquashMergeStrategy}
|
||||
*
|
||||
* @param prNumber Number of the pull request that should be merged.
|
||||
* @param githubToken Github token used for merging (i.e. fetching and pushing)
|
||||
* @param projectRoot Path to the local Git project that is used for merging.
|
||||
* @param config Configuration for merging pull requests.
|
||||
* @param flags Configuration options for merging pull requests.
|
||||
*/
|
||||
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
|
||||
|
@ -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
|
||||
* and optional explicit configuration. An explicit configuration can be specified
|
||||
* when the merge script is used outside of a `ng-dev` configured repository.
|
||||
* Creates the pull request merge task using the given configuration options. Explicit configuration
|
||||
* options can be specified when the merge script is used outside of an `ng-dev` configured
|
||||
* repository.
|
||||
*/
|
||||
async function createPullRequestMergeTask(flags: PullRequestMergeTaskFlags) {
|
||||
const devInfraConfig = getConfig();
|
||||
|
|
Loading…
Reference in New Issue