Skip to content

Commit 41f3b5e

Browse files
author
awstools
committed
docs(client-codebuild): This release adds support for a new webhook event: PULL_REQUEST_CLOSED.
1 parent c0f750c commit 41f3b5e

File tree

3 files changed

+101
-75
lines changed

3 files changed

+101
-75
lines changed

‎clients/client-codebuild/src/commands/StartBuildCommand.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ export interface StartBuildCommandOutput extends StartBuildOutput, __MetadataBea
2828

2929
/**
3030
* @public
31-
* <p>Starts running a build.</p>
31+
* <p>Starts running a build with the settings defined in the project. These setting include: how to run a build,
32+
* where to get the source code, which build environment to use, which build commands to run, and where to store the build output.</p>
33+
* <p>You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that
34+
* specific start build request. The settings in the project are unaltered.</p>
3235
* @example
3336
* Use a bare-bones client and the command you need to make an API call.
3437
* ```javascript

‎clients/client-codebuild/src/models/models_0.ts‎

Lines changed: 94 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -3424,77 +3424,94 @@ export interface WebhookFilter {
34243424
* <p> The type of webhook filter. There are six webhook filter types: <code>EVENT</code>,
34253425
* <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>,
34263426
* <code>FILE_PATH</code>, and <code>COMMIT_MESSAGE</code>. </p>
3427-
* <dl>
3428-
* <dt>
3429-
* EVENT
3430-
* </dt>
3431-
* <dd>
3432-
* <p> A webhook event triggers a build when the provided <code>pattern</code>
3433-
* matches one of five event types: <code>PUSH</code>,
3427+
* <ul>
3428+
* <li>
3429+
* <p>
3430+
* EVENT
3431+
* </p>
3432+
* <ul>
3433+
* <li>
3434+
* <p> A webhook event triggers a build when the provided <code>pattern</code>
3435+
* matches one of six event types: <code>PUSH</code>,
34343436
* <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>,
3437+
* <code>PULL_REQUEST_CLOSED</code>,
34353438
* <code>PULL_REQUEST_REOPENED</code>, and
3436-
* <code>PULL_REQUEST_MERGED</code>. The <code>EVENT</code> patterns are
3437-
* specified as a comma-separated string. For example, <code>PUSH,
3438-
* PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull
3439-
* request created, and pull request updated events. </p>
3440-
* <note>
3441-
* <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub
3442-
* Enterprise only. </p>
3443-
* </note>
3444-
* </dd>
3445-
* <dt>
3446-
* ACTOR_ACCOUNT_ID
3447-
* </dt>
3448-
* <dd>
3449-
* <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or
3450-
* Bitbucket account ID matches the regular expression <code>pattern</code>.
3451-
* </p>
3452-
* </dd>
3453-
* <dt>
3454-
* HEAD_REF
3455-
* </dt>
3456-
* <dd>
3457-
* <p> A webhook event triggers a build when the head reference matches the
3458-
* regular expression <code>pattern</code>. For example,
3439+
* <code>PULL_REQUEST_MERGED</code>. The <code>EVENT</code> patterns are
3440+
* specified as a comma-separated string. For example, <code>PUSH,
3441+
* PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull
3442+
* request created, and pull request updated events. </p>
3443+
* <note>
3444+
* <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub
3445+
* Enterprise only. </p>
3446+
* </note>
3447+
* </li>
3448+
* </ul>
3449+
* </li>
3450+
* <li>
3451+
* <p>ACTOR_ACCOUNT_ID</p>
3452+
* <ul>
3453+
* <li>
3454+
* <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or
3455+
* Bitbucket account ID matches the regular expression <code>pattern</code>.
3456+
* </p>
3457+
* </li>
3458+
* </ul>
3459+
* </li>
3460+
* <li>
3461+
* <p>HEAD_REF</p>
3462+
* <ul>
3463+
* <li>
3464+
* <p> A webhook event triggers a build when the head reference matches the
3465+
* regular expression <code>pattern</code>. For example,
34593466
* <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p>
3460-
* <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub
3461-
* Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
3462-
* </p>
3463-
* </dd>
3464-
* <dt>
3465-
* BASE_REF
3466-
* </dt>
3467-
* <dd>
3468-
* <p> A webhook event triggers a build when the base reference matches the
3469-
* regular expression <code>pattern</code>. For example,
3467+
* <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub
3468+
* Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
3469+
* </p>
3470+
* </li>
3471+
* </ul>
3472+
* </li>
3473+
* <li>
3474+
* <p>BASE_REF</p>
3475+
* <ul>
3476+
* <li>
3477+
* <p> A webhook event triggers a build when the base reference matches the
3478+
* regular expression <code>pattern</code>. For example,
34703479
* <code>refs/heads/branch-name</code>. </p>
3471-
* <note>
3472-
* <p> Works with pull request events only. </p>
3473-
* </note>
3474-
* </dd>
3475-
* <dt>
3476-
* FILE_PATH
3477-
* </dt>
3478-
* <dd>
3479-
* <p> A webhook triggers a build when the path of a changed file matches the
3480-
* regular expression <code>pattern</code>. </p>
3481-
* <note>
3482-
* <p> Works with GitHub and Bitbucket events push and pull requests events.
3483-
* Also works with GitHub Enterprise push events, but does not work with
3484-
* GitHub Enterprise pull request events. </p>
3485-
* </note>
3486-
* </dd>
3487-
* <dt>COMMIT_MESSAGE</dt>
3488-
* <dd>
3489-
* <p>A webhook triggers a build when the head commit message matches the
3490-
* regular expression <code>pattern</code>.</p>
3491-
* <note>
3492-
* <p> Works with GitHub and Bitbucket events push and pull requests events.
3493-
* Also works with GitHub Enterprise push events, but does not work with
3494-
* GitHub Enterprise pull request events. </p>
3495-
* </note>
3496-
* </dd>
3497-
* </dl>
3480+
* <note>
3481+
* <p> Works with pull request events only. </p>
3482+
* </note>
3483+
* </li>
3484+
* </ul>
3485+
* </li>
3486+
* <li>
3487+
* <p>FILE_PATH</p>
3488+
* <ul>
3489+
* <li>
3490+
* <p> A webhook triggers a build when the path of a changed file matches the
3491+
* regular expression <code>pattern</code>. </p>
3492+
* <note>
3493+
* <p> Works with GitHub and Bitbucket events push and pull requests events.
3494+
* Also works with GitHub Enterprise push events, but does not work with
3495+
* GitHub Enterprise pull request events. </p>
3496+
* </note>
3497+
* </li>
3498+
* </ul>
3499+
* </li>
3500+
* <li>
3501+
* <p>COMMIT_MESSAGE</p>
3502+
* <ul>
3503+
* <li>
3504+
* <p>A webhook triggers a build when the head commit message matches the
3505+
* regular expression <code>pattern</code>.</p>
3506+
* <note>
3507+
* <p> Works with GitHub and Bitbucket events push and pull requests events.
3508+
* Also works with GitHub Enterprise push events, but does not work with
3509+
* GitHub Enterprise pull request events. </p>
3510+
* </note>
3511+
* </li>
3512+
* </ul>
3513+
* </li>
3514+
* </ul>
34983515
*/
34993516
type: WebhookFilterType | undefined;
35003517

@@ -6936,16 +6953,22 @@ export interface StartBuildInput {
69366953

69376954
/**
69386955
* @public
6939-
* <p>A buildspec file declaration that overrides, for this build only, the latest one
6940-
* already defined in the build project.</p>
6941-
* <p> If this value is set, it can be either an inline buildspec definition, the path to an
6956+
* <p>A buildspec file declaration that overrides the latest one defined
6957+
* in the build project, for this build only. The buildspec defined on the project is not changed.</p>
6958+
* <p>If this value is set, it can be either an inline buildspec definition, the path to an
69426959
* alternate buildspec file relative to the value of the built-in
69436960
* <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket.
69446961
* The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
69456962
* file using its ARN (for example,
69466963
* <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not
69476964
* provided or is set to an empty string, the source code must contain a buildspec file in
6948-
* its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>. </p>
6965+
* its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>.</p>
6966+
* <note>
6967+
* <p>Since this property allows you to change the build commands that will run in the container,
6968+
* you should note that an IAM principal with the ability to call this API and set this parameter
6969+
* can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location
6970+
* like a file in your source repository or a Amazon S3 bucket.</p>
6971+
* </note>
69496972
*/
69506973
buildspecOverride?: string;
69516974

0 commit comments

Comments
 (0)